DefectSimulator Class Reference

virtual class for defect simulators More...

Inheritance diagram for DefectSimulator:

List of all members.

Public Member Functions
	DefectSimulator (const DefectixOptions::Options &options)
	Standard constructor.
const errorCodes	exec ()
	Main function.
virtual void	addDefectsOnExtension (int nb, int extend)
	Add defects on a extension.
virtual void	addDefectsOnMosaic (int nb)
	Add defects on the whole mosaic.
virtual void	addDefectsPerExtension (int nb)
	Add defects on the whole mosaic.
Protected Member Functions
const errorCodes	writeAllImageExtensions ()
	Write extensions in a MEF file.
virtual void	createDefect (gsl_matrix *src, gsl_matrix *mask, int extend)=0
	Create a defect.
Protected Attributes
FitsManager	_outputMgr
	FitsManager for output.
int	_nbDefects
	Number of defects to add.
int	_type
	Addition mode, 'extension' or 'mosaic'.
int	_intensity
	Intensity of the defects.

---

Detailed Description

virtual class for defect simulators

The class defines functions to produce easily new simulators as subclasses

---

Constructor & Destructor Documentation

DefectSimulator::DefectSimulator (  const DefectixOptions::Options &  options  )

Standard constructor. The constructor calls Defectix::Defectix(options) and then initialises private members with 'options' values. Parameters: options  Class containing every parameters set by the user (or default)

---

Member Function Documentation

void DefectSimulator::addDefectsOnExtension (  int  nb, int  extend )  [virtual]

Add defects on a extension. The function adds a given number of defects on a given extension of the loaded MEF file. Parameters: nb  number of defects to add extend  position of the extension to treat

void DefectSimulator::addDefectsOnMosaic (  int  nb  )  [virtual]

Add defects on the whole mosaic. The function adds a given number of defects on the loaded MEF file with a random distribution on extensions. Parameters: nb  number of defects to add

void DefectSimulator::addDefectsPerExtension (  int  nb  )  [virtual]

Add defects on the whole mosaic. The function adds a given number of defects on each extension of the loaded MEF file. Parameters: nb  number of defects to add

void DefectSimulator::createDefect (  gsl_matrix *  src, gsl_matrix *  mask, int  extend )  [protected, pure virtual]

Create a defect. The function adds a defect according to the simulator Parameters: src  image to add the defect on mask  mask to add the defect on extend  position of the extension to treat Implemented in HaloSimulator, and TrailSimulator.

const errorCodes DefectSimulator::exec (   )  [virtual]

Main function. The function starts the defect addition Implements Defectix.

const errorCodes DefectSimulator::writeAllImageExtensions (   )  [protected]

Write extensions in a MEF file. The function write every loaded extension in a MEF file

---

Member Data Documentation

int DefectSimulator::_intensity [protected]

Intensity of the defects. _intensity is defined as the average value compared to the maximum value of the image 'max'. The computation is 'max' / '_intensity'.

int DefectSimulator::_nbDefects [protected]

Number of defects to add. The _nbDefects is the chosen number of defects to add.

int DefectSimulator::_type [protected]

Addition mode, 'extension' or 'mosaic'. 'extension' calls DefectSimulator::addDefectsPerExtension(); 'mosaic' calls DefectSimulator::addDefectsOnMosaic();

---

The documentation for this class was generated from the following file:

• simulator.dox

---