scripts/sig_configs/sigconf_planar.cdl

// **************************************************************
// **************************************************************
// *********** netcdf configuration file for SIG program  *******
// *********** Version 1.0                                *******
// **************************************************************
// **************************************************************
// **************************************************************
// ** EUROPIV II Project                                       **
// ** Synthetic Image Generator                                **
// ** Feb. 2001                                                **
// **************************************************************
// ** Bertrand Lecordier : Bertrand.Lecordier@coria.fr         **
// ** Jerry Westerweel   : j.westerweel@wbmt.tudelft.nl        **
// *************************************************************/


netcdf sig_conf {

dimensions:
	d_chaine	=	unlimited;


//*********************************************
//************************Variables ***********
//*********************************************

variables:

	int	p_dimX;
			p_dimX:valid_min	=	1;
			p_dimX:valid_max	=	4096;
			p_dimX:units		=	"pixel";
			p_dimX:long_name	=	"main image width";

	int	p_dimY;
			p_dimY:valid_min	=	1;
			p_dimY:valid_max	=	4096;
			p_dimY:units		=	"pixel";
			p_dimY:long_name	=	"main image height";

	int	p_dimL;
			p_dimL:valid_min	=	0;
			p_dimL:valid_max	=	1024;
			p_dimL:units		=	"pixel";
			p_dimL:long_name	=	"left strip";

	int	p_dimR;
			p_dimR:valid_min	=	0;
			p_dimR:valid_max	=	1024;
			p_dimR:units		=	"pixel";
			p_dimR:long_name	=	"right strip";

	int	p_dimT;
			p_dimT:valid_min	=	0;
			p_dimT:valid_max	=	1024;
			p_dimT:units		=	"pixel";
			p_dimT:long_name	=	"top strip";
	
	int	p_dimB;
			p_dimB:valid_min	=	0;
			p_dimB:valid_max	=	1024;
			p_dimB:units		=	"pixel";
			p_dimB:long_name	=	"bottom strip";	

	char	periodic_flag(d_chaine);

//*********************************************
//*********************************************
//     Particle field dimension (real space)
//     r_[x,y,z]min, r_[x,y,z]max defined the region of interest
//     into the particle field - the particle field can be largeur
//
//	The magnification factor is obtained from
//	Gx = (r_xmax-r_xmin)/p_dimX (real/pixel) 
//	Gy = (r_ymax-r_ymin)/p_dimY (real/pixel)
//	Important : Gx and Gy can be different

	// ******* X axis **************************
	double		r_xmin;
			r_xmin:units		=	"real";
			r_xmin:long_name	=	"x minimum";

	double		r_xmax;
			r_xmax:units		=	"real";
			r_xmax:long_name	=	"x maximum";

	// ******* Y axis **************************
	double		r_ymin;
			r_ymin:units		=	"real";
			r_ymin:long_name	=	"y minimum";

	double		r_ymax;
			r_ymax:units		=	"real";
			r_ymax:long_name	=	"y maximum";	

	// ******* Z axis ***************************
	// ** for the 2D particle (x,y), used the same value for
	// ** r_zmin, r_zmin and sheet_rpos_z
	double		r_zmin;
			r_zmin:units		=	"real";
			r_zmin:long_name	=	"z minimum";

	double		r_zmax;
			r_zmax:units		=	"real";
			r_zmax:long_name	=	"z maximum";	


// ****************************************
// ****************************************
// Light sheet information
// ****************************************
// ****************************************

	char 	lsheet_type(d_chaine);
		lsheet_type:long_name	=	"type of light sheet";
					// possible values : 
					//		uniform
					//		gaussian
					//		triangle
					// 		cosine
					//		squarecosine
	
	// location in the real domain of the center 
	// of laser sheet (perpendicular to the z axis)
	double 	lsheet_rpos_z;
		lsheet_rpos_z:units	=	"real";
		lsheet_rpos_z:long_name	=	"z location of light sheet";

	double	lsheet_rthickness;
		lsheet_rthickness:valid_min	=	0.0;
		lsheet_rthickness:units		=	"real";
		lsheet_rthickness:long_name	=	"light sheet thickness";

	double	lsheet_wave_length;
		lsheet_wave_length:valid_min	= 	0.0;
		lsheet_wave_length:units	=	"real";
		lsheet_wave_length:long_name	= 	"laser wave length";

// ************************************************
// ************* Particle distribution ************
// ************************************************

	char	part_distribution(d_chaine);
					// Possible alternative
					// uniform : constant diameter equal to part_mean_diam
					//           
					// gaussian: gaussian distribution for the particle diameter
					//           mean diameter : part_mean_diam
					//           std  diameter : part_std_diam
	double	part_min_diam;
			part_min_diam:valid_min	=	0.0;
			part_min_diam:long_name =	"minimum particle diameter";
	double	part_max_diam;
			part_max_diam:valid_min	=	0.0;
			part_max_diam:valid_max	=	10.0;
			part_max_diam:long_name =	"maximum particle diameter";
	double	part_mean_diam;
			part_mean_diam:long_name=	"mean particle diamete";
	double	part_std_diam;
			part_std_diam:long_name=	"std. of distribution of particle diameter";

// *****************************************************
// ************ image pattern information **************
// *****************************************************

	char	pattern_type(d_chaine);
						// possible values
						// gaussian : gaussian particle shape
						// circle   : circle particle shape
						// rectangle: rectangle particle shape
	double	pattern_meanx;
			pattern_meanx:valid_min =	0.0;
			pattern_meanx:long_name	=	"pattern size for the part_meanx_diam";
	double	pattern_meany;
			pattern_meany:valid_min =	0.0;
			pattern_meany:long_name	=	"pattern size for the part_meany_diam";


// ************************************************
// ************ Projection information ************
// ************************************************

	char	projection_type(d_chaine);
						// possible values
						// normal  : Normal projection without effect of particle motion along z
						// znormal : Normal projection with effect of particule motion along z
						// angular : Angular projection for stereo PIV
					
	double projection_angle;					// For angular projection
			projection_angle:valid_min = 		0.0;
			projection_angle:valid_max =    	360;
			projection_angle:long_name =    	"Angle of view";
	double projection_tilt_angle;					// For angular projection
			projection_tilt_angle:valid_min = 	0.0;
			projection_tilt_angle:valid_max =    	360;
			projection_tilt_angle:long_name =    	"Tilt angle";

// ************************************************
// ************* CCD information       ************
// ************************************************

	// Pixel active area size : ccd_fill_ratio_x*ccd_fill_ratio_y
	double	ccd_fill_ratio_x;
			ccd_fill_ratio_x:valid_min	=	0.0;
			ccd_fill_ratio_x:valid_max	=	1.0;
			ccd_fill_ratio_x:long_name	=	"X CCD fill ration";
	double	ccd_fill_ratio_y;
			ccd_fill_ratio_y:valid_min	=	0.0;
			ccd_fill_ratio_y:valid_max	=	1.0;
			ccd_fill_ratio_y:long_name	=	"Y CCD fill ration";	
	double	ccd_saturation_level;
			ccd_saturation_level:valid_min		=	0.0;
			ccd_saturation_level:valid_max		=	1.0;
			ccd_saturation_level:long_name		=	"saturation level";
			


	//****** Initial background information *******/

	char ccd_background_type(d_chaine);
					// Possible alternative
					// uniform : uniform background with 
					//           level ccd_background_mean_level
					// gaussian: gaussian noise with a mean value
					//           equal to ccd_background_mean_level
					//           and a std. equal to ccd_background_std_noise
	double	ccd_background_mean_level;
			ccd_background_mean_level:valid_min	=	0;
			ccd_background_mean_level:long_name	=	"mean initial background level";
	double	ccd_background_std_noise;
			ccd_background_std_noise:valid_min	=	0;
			ccd_background_std_noise:long_name	=	"std. noise for initial background";

	double  ccd_pixel_horizontal_pitch;
			ccd_pixel_horizontal_pitch:valid_min		=	0.0;
			ccd_pixel_horizontal_pitch:units		=	"pixel/real";
			ccd_pixel_horizontal_pitch:long_name		=	"horizontal pixel pitch";

	double ccd_pixel_vertical_pitch;
			ccd_pixel_vertical_pitch:valid_min		=	0.0;
			ccd_pixel_vertical_pitch:units			=	"pixel/real";
			ccd_pixel_vertical_pitch:long_name		=	"vertical pixel pitch";


// *************************************************
// **********optics information ********************
// *************************************************

	double 	optic_object_distance;
			optic_object_distance:long_name		=	"object distance";

	double 	optic_image_distance;
			optic_image_distance:long_name		=	"image distance";

 	double	optic_aperture;
			optic_aperture:valid_min		=	1.;
			optic_aperture:long_name		=	"optic aperture";

  	double        optic_magnification;
			optic_magnification:valid_min		=	0.0;
			optic_magnification:long_name		=	"optic magnification";



	

// ************************************************
// ** initial seed numbers for the random generator 
// ************************************************

	int	seed_number1;
			seed_number1:valid_min	=	0;
			seed_number1:valid_max	=	30000;
			seed_number1:long_name	=	"seed number 1";

	int	seed_number2;
			seed_number2:valid_min	=	0;
			seed_number2:valid_max	=	30000;
			seed_number2:long_name	=	"seed number 2";

	int	seed_number3;
			seed_number3:valid_min	=	0;
			seed_number3:valid_max	=	30000;
			seed_number3:long_name	=	"seed number 3";
data:

 p_dimX = 2048 ;

 p_dimY = 2048 ;

 p_dimL = 0 ;

 p_dimR = 0 ;

 p_dimT = 0 ;

 p_dimB = 0 ;

 periodic_flag = "no_periodic" ;

 r_xmin = 0 ;

 r_xmax = 150;

 r_ymin = -150 ;

 r_ymax = 0 ;

 r_zmin = -0.6 ;

 r_zmax = 0.6 ;

 lsheet_type = "uniform" ;

 lsheet_rpos_z = 0 ;

 lsheet_rthickness = 1.2 ;

 lsheet_wave_length = 532e-9 ;

 part_distribution = "uniform" ;

 part_min_diam = 0.7 ;

 part_max_diam =  0.7;

 part_mean_diam = 0.7 ;

 part_std_diam = 0;

 pattern_type = "gaussian" ;

 pattern_meanx = 1.274;

 pattern_meany = 1.274 ;

 projection_type = "normal" ;

 projection_angle = 0 ;

 projection_tilt_angle = 0 ;

 ccd_fill_ratio_x = 1 ;

 ccd_fill_ratio_y = 1 ;

 ccd_saturation_level = 1 ;

 ccd_background_type = "gaussian" ;

 ccd_background_mean_level = 0 ;

 ccd_background_std_noise = 0 ;

 ccd_pixel_horizontal_pitch = 327.68 ;

 ccd_pixel_vertical_pitch = 327.68 ;

 optic_object_distance = 5000 ;

 optic_image_distance = 208.5 ;

 optic_aperture = 2 ;

 optic_magnification = 0.0417;

 seed_number1 = 1 ;

 seed_number2 = 100 ;

 seed_number3 = 10000 ;
}