;+
; NAME:
;	SMEI_SEQUENCE__DEFINE
;
;
; PURPOSE:
;	Object definition of a SMEI image sequence
;
;
; CATEGORY:
;	SMEI_SEQUENCE
;
;
; FIELDS:
;	name		string	An arbitrary name to label the sequence
;	first_image	objref	A reference to the first object of the
;				sequence.
;	last_image	objref	A reference to the final object of the
;				sequence.
;	n_image		long	The number of images in the sequence.
;	colour_table	byte	The colour table to use for display.
;	options.date	byte	Whether to add the image date to plots
;		grid	byte	Whether to overlay the coordinate grid
;				on plots
;		file	byte	Whether to put the filename on plots
;		range	byte	Whether to put the data range on plots.
;		window	long	The window index of the display window.
;		data_range float The data range to display.
;		data_kill float Points outside this level are set to undefined.
;		data_log byte	Whether data display is linear or
;				logarithmic.
;		delay	float	The delay between frames in a movie.
;		plane	int	The image plane to display (0 =
;				processed, 1=raw image plane 0 etc.)
;		flags	uint	The contaminants to reject in display.
;		pa_shift int	Alignment of Rectangular images.
;		no_roll	byte	Whether to wrap scrolling of sequence
;				(this is the negation of what the
;				methods return, so that older
;				sequences keep their behaviour when
;				restored).
;	mask_bits	struct	The bit patterns of the
;				mask. (implemented as a pointer for
;				datasets without masking info).
;	print_options	struct	Options for PostScript output.
;	pixmap.id	long	The window ID of the pixmap used for
;				fast display
;		hwm	long	The next available row in the
;				pixmap. It's 1 pixel above the top
;				left corner of the last image added.
;		colwidth long	The width of a column of images in the
;				pixmap
;	sourcedir	string	The directory tree of the last
;				image(s) added to the sequence.	
;	file		string	The savefile name used for the sequence.
;	canvas		long	The widget ID of the plotting widget
;				(N.B. this is not the same as the
;				window ID).
;
; MODIFICATION HISTORY:
;	Original: 9/12/02; SJT
;	Fixed range scaling info, added colour table: 12/12/02; SJT
;	Incorporate DELAY: 19/12/02; SJT
;	Update Doc comments and remove disused fields: 9/1/03; SJT
;	Add logarithmic option, make pixmap hwm 2-D: 10/1/03; SJT
;	Add plane option, (to allow display of raw image planes):
;	16/5/03; SJT
;	Separate in and out of sky for null pixels: 18/7/03; SJT
;	Add print settings: 22/7/03; SJT
;	Add sourcedir: 29/10/03; SJT
;	Add data_kill: 29/3/04; SJT
;	Add spooling commands for print: 6/6/05; SJT
;	Add masking flags for Pipe 2.0: 23/10/07; SJT
;	Add pa_shift (rect only): 23/11/09; SJT
;	Add CMYK for PS: 3/6/10; SJT
;	Add no_roll option: 20/7/10; SJT
;-

pro smei_sequence__define

smei_sequence = {smei_sequence, $
                 name: "", $
                 first_image: obj_new(), $
                 last_image: obj_new(), $
                 n_image: 0l, $
                 colour_table: bytarr(256, 3), $
                 null_index: bytarr(2, 2), $
                 options: {smei_seq_opts, $
                           date: 0b, $
                           grid: 0b, $
                           file: 0b, $
                           range: 0b, $
                           window: 0l, $
                           data_range: fltarr(2), $
                           data_kill: fltarr(2), $
                           data_log: 0b, $
                           delay: 0., $
                           plane: 0, $
                           zoom_factor: 0, $
                           zoom_smooth: 0b, $
                           flags: 0u, $
                           pa_shift: 0, $
                           no_roll: 0b}, $
                 mask_bits: ptr_new(), $ ; pointer in case not there
                 print_options: {smei_s_print_opts, $
                                 columns: 0, $
                                 rows: 0, $
                                 order: 0b, $
                                 type: 0, $
                                 xsize: 0., $
                                 ysize: 0., $
                                 file:'', $
                                 print: '', $
                                 preview: '', $
                                 cmyk: 0b}, $
                 pixmap: {smei_seq_pm, $
                          id:0l, $
                          hwm: lonarr(2), $
                          colwidth: 0l}, $
                 sourcedir: '', $
                 file: '', $
                 canvas: 0l $
                }

end