SATURATE_MAP format

Functions
moo_saturate_map *	moo_saturate_map_new (void)
	Create a new moo_saturate_map.
cpl_error_code	moo_saturate_map_set_data (moo_saturate_map *self, moo_detector_type type, int ntas, cpl_image *data, cpl_image *flux, cpl_image *err, cpl_image *exptime, cpl_propertylist *header)
	set saturate map data for relevant extension
cpl_error_code	moo_saturate_map_add_data (moo_saturate_map *self, cpl_image *data, cpl_image *flux, cpl_image *err, cpl_image *exptime, moo_detector_type type, int ntas)
	Add CPL_IMAGE extension to MAP filename and update moo_saurate_map structure.
void	moo_saturate_map_save (moo_saturate_map *self, const char *filename)
	Save a moo_saturate_map to a FITS file.
void	moo_saturate_map_delete (moo_saturate_map *self)
	Delete a moo_map_saturate.

Detailed Description

This module provides functions to create, use, and destroy a moo_saturate_map

Functionality include:

Synopsis:

#include "moo_saturate_map.h"

Function Documentation

moo_saturate_map_add_data()

cpl_error_code moo_saturate_map_add_data	(	moo_saturate_map *	self,
		cpl_image *	data,
		cpl_image *	flux,
		cpl_image *	err,
		cpl_image *	exptime,
		moo_detector_type	type,
		int	ntas
	)

Add CPL_IMAGE extension to MAP filename and update moo_saurate_map structure.

Parameters

self	moo_bpm structure to update
data	CPL_IMAGE extension to store
flux	CPL_IMAGE flux extension to store
err	CPL_IMAGE error extension to store
exptime	CPL_IMAGE extension to store
type	type of detector
ntas	number of spectrographs

Possible cpl_error_code set in this function:

• CPL_ERROR_NULL_INPUT if an input pointer is NULL

Definition at line 174 of file moo_saturate_map.c.

References moo_detector_get_extname(), and moo_saturate_map_set_data().

moo_saturate_map_delete()

void moo_saturate_map_delete

(

moo_saturate_map *

self

)

Delete a moo_map_saturate.

Parameters

self	moo_saturate_map to delete

Returns

void

If the moo_saturate_map self is NULL, nothing is done and no error is set.

Definition at line 298 of file moo_saturate_map.c.

moo_saturate_map_new()

moo_saturate_map * moo_saturate_map_new

(

void

)

Create a new moo_saturate_map.

Returns

1 newly allocated moo_saturate_map or NULL in case of an error

The returned object must be deallocated using moo_saturate_map_delete().

Definition at line 66 of file moo_saturate_map.c.

moo_saturate_map_save()

void moo_saturate_map_save	(	moo_saturate_map *	self,
		const char *	filename
	)

Save a moo_saturate_map to a FITS file.

Parameters

self	moo_saturate_map to write to disk or NULL
filename	Name of the file to write

Returns

CPL_ERROR_NONE or the relevant cpl_error_code on error

This function saves a moo_bpm to a FITS file, using cfitsio. Only not NULL extensions are written.

Definition at line 261 of file moo_saturate_map.c.

References moo_detector_get_extname(), and moo_fits_write_extension_image().

Referenced by moo_products_add_saturate_map().

moo_saturate_map_set_data()

cpl_error_code moo_saturate_map_set_data	(	moo_saturate_map *	self,
		moo_detector_type	type,
		int	ntas,
		cpl_image *	data,
		cpl_image *	flux,
		cpl_image *	err,
		cpl_image *	exptime,
		cpl_propertylist *	header
	)

set saturate map data for relevant extension

Parameters

self
type	the detector type
ntas	number of TAS
data	the map data
flux	the map flux
err	the map err
exptime	the map exptime
header	the map header

Returns

error code

Definition at line 137 of file moo_saturate_map.c.

Referenced by moo_saturate_map_add_data().