MASK format

Functions
moo_mask *	moo_mask_new (void)
	Create a new moo_mask
cpl_mask *	moo_mask_get (moo_mask *self, moo_detector_type type, int num)
	Get the cpl_mask associated to given type,num.
cpl_error_code	moo_mask_set (moo_mask *self, moo_detector_type type, int num, cpl_mask *mask)
	Set the cpl_mask associated to given type,num.
void	moo_mask_delete (moo_mask *self)
	Delete a moo_mask.
void	moo_mask_save (moo_mask *self, const char *filename)
	Save a moo_mask to a FITS file.

Detailed Description

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

Functionality include:

Synopsis:

#include "moo_mask.h"

Function Documentation

moo_mask_delete()

void moo_mask_delete

(

moo_mask *

self

)

Delete a moo_mask.

Parameters

self	moo_mask to delete

Returns

void

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

Definition at line 124 of file moo_mask.c.

Referenced by moo_masklist_delete().

moo_mask_get()

cpl_mask * moo_mask_get	(	moo_mask *	self,
		moo_detector_type	type,
		int	num
	)

Get the cpl_mask associated to given type,num.

Parameters

self	moo_mask to read
type	the detector type
num	the TAS number

Returns

the relevant cpl_mask or NULL

Definition at line 81 of file moo_mask.c.

Referenced by moo_compute_noise_map(), and moo_masklist_get_mask().

moo_mask_new()

moo_mask * moo_mask_new

(

void

)

Create a new moo_mask

Returns

1 newly allocated moo_mask or NULL in case of an error

The returned object must be deallocated using moo_mask_delete().

Definition at line 64 of file moo_mask.c.

Referenced by moo_masklist_create().

moo_mask_save()

void moo_mask_save	(	moo_mask *	self,
		const char *	filename
	)

Save a moo_mask to a FITS file.

Parameters

self	moo_mask 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_map to a FITS file, using cfitsio. Only not NULL extensions are written.

Definition at line 150 of file moo_mask.c.

References moo_detector_get_extname(), moo_fits_create(), and moo_fits_write_extension_mask().

moo_mask_set()

cpl_error_code moo_mask_set	(	moo_mask *	self,
		moo_detector_type	type,
		int	num,
		cpl_mask *	mask
	)

Set the cpl_mask associated to given type,num.

Parameters

self	moo_mask to read
type	the detector type
num	the TAS number
mask	the new cpl_mask to set

Definition at line 103 of file moo_mask.c.