CR2RE Pipeline Reference Manual 1.6.7
Functions
DFS related functions

Functions

cpl_error_code cr2res_dfs_set_groups (cpl_frameset *set)
 Set the group as RAW or CALIB in a frameset.
 
char * cr2res_dfs_POL_WAVELENGTH_colname (int order_idx)
 Get the POL_WAVELENGTH column name for a given order.
 
char * cr2res_dfs_POL_STOKES_colname (int order_idx)
 Get the POL_STOKES column name for a given order.
 
char * cr2res_dfs_POL_STOKES_ERROR_colname (int order_idx)
 Get the POL_STOKES_ERROR column name for a given order.
 
char * cr2res_dfs_POL_NULL_colname (int order_idx)
 Get the POL_NULL column name for a given order.
 
char * cr2res_dfs_POL_NULL_ERROR_colname (int order_idx)
 Get the POL_NULL_ERROR column name for a given order.
 
char * cr2res_dfs_POL_INTENS_colname (int order_idx)
 Get the POL_INTENS column name for a given order.
 
char * cr2res_dfs_POL_INTENS_ERROR_colname (int order_idx)
 Get the POL_INTENS_ERROR column name for a given order.
 
char * cr2res_dfs_CONVERSION_colname (int order_idx, int trace)
 Get the CONVERSION column name for a given order/trace.
 
char * cr2res_dfs_SENSITIVITY_colname (int order_idx, int trace)
 Get the SENSITIVITY column name for a given order/trace.
 
char * cr2res_dfs_THROUGHPUT_colname (int order_idx, int trace)
 Get the THROUGHPUT column name for a given order/trace.
 
char * cr2res_dfs_SPEC_colname (int order_idx, int trace)
 Get the SPEC column name for a given order/trace.
 
char * cr2res_dfs_WAVELENGTH_colname (int order_idx, int trace)
 Get the WAVELENGTH column name for a given order/trace.
 
char * cr2res_dfs_SPEC_ERR_colname (int order_idx, int trace)
 Get the ERR column name for a given order/trace.
 
char * cr2res_dfs_SLIT_FUNC_colname (int order_idx, int trace)
 Get the SLIT_FUNC table column name for a given order/trace.
 
char * cr2res_dfs_POSITIONX_colname (int order_idx, int trace)
 Get the POSITIONX table column name for a given order/trace.
 
char * cr2res_dfs_POSITIONY_colname (int order_idx, int trace)
 Get the POSITIONY table column name for a given order/trace.
 
char * cr2res_dfs_SLIT_FRACTION_colname (int order_idx, int trace)
 Get the SLIT_FRACTION table column name for a given order/trace.
 
char * cr2res_dfs_SPEC_colname_parse (const char *colname, int *order_idx, int *trace)
 Parse a column name ORDER_TRACE_TYPE format.
 
char * cr2res_dfs_POL_colname_parse (const char *colname, int *order_idx)
 Parse a column name ORDER_TYPE format.
 
cpl_table * cr2res_dfs_create_lines_diagnostics_table (int nrows)
 Create an empty LINES DIAGNOSTICS table.
 
int cr2res_dfs_check_traces_table (const cpl_table *traces)
 Check completeness of trace table.
 

Detailed Description

Function Documentation

◆ cr2res_dfs_check_traces_table()

int cr2res_dfs_check_traces_table ( const cpl_table *  traces)

Check completeness of trace table.

Parameters
traceThe trace table to check
Returns
1 if complete, 0 if not, -1 in error case

Definition at line 581 of file cr2res_dfs.c.

Referenced by cr2res_trace_new_slit_fraction().

◆ cr2res_dfs_CONVERSION_colname()

char * cr2res_dfs_CONVERSION_colname ( int  order_idx,
int  trace 
)

Get the CONVERSION column name for a given order/trace.

Parameters
order_idxThe order index (-49->50)
traceThe trace number (1->)
Returns
the column name or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 324 of file cr2res_dfs.c.

References cr2res_io_convert_order_idx_to_idxp().

Referenced by cr2res_photom_engine().

◆ cr2res_dfs_create_lines_diagnostics_table()

cpl_table * cr2res_dfs_create_lines_diagnostics_table ( int  nrows)

Create an empty LINES DIAGNOSTICS table.

Parameters
nrowsThe wished number of rows
Returns
a new table

Definition at line 553 of file cr2res_dfs.c.

Referenced by cr2res_etalon_wave_2d(), and cr2res_wave_2d().

◆ cr2res_dfs_POL_colname_parse()

char * cr2res_dfs_POL_colname_parse ( const char *  colname,
int *  order_idx 
)

Parse a column name ORDER_TYPE format.

Parameters
colnameThe column name to parse
order_idx[out] The order index (-49->50)
trace[out] The trace number (1->)
Returns
the column TYPE or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 531 of file cr2res_dfs.c.

Referenced by cr2res_idp_create_table().

◆ cr2res_dfs_POL_INTENS_colname()

char * cr2res_dfs_POL_INTENS_colname ( int  order_idx)

Get the POL_INTENS column name for a given order.

Parameters
order_idxThe order index (-49->50)
Returns
the column name or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 290 of file cr2res_dfs.c.

References cr2res_io_convert_order_idx_to_idxp().

Referenced by cr2res_pol_POL_SPEC_create().

◆ cr2res_dfs_POL_INTENS_ERROR_colname()

char * cr2res_dfs_POL_INTENS_ERROR_colname ( int  order_idx)

Get the POL_INTENS_ERROR column name for a given order.

Parameters
order_idxThe order index (-49->50)
Returns
the column name or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 306 of file cr2res_dfs.c.

References cr2res_io_convert_order_idx_to_idxp().

Referenced by cr2res_pol_POL_SPEC_create().

◆ cr2res_dfs_POL_NULL_colname()

char * cr2res_dfs_POL_NULL_colname ( int  order_idx)

Get the POL_NULL column name for a given order.

Parameters
order_idxThe order index (-49->50)
Returns
the column name or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 258 of file cr2res_dfs.c.

References cr2res_io_convert_order_idx_to_idxp().

Referenced by cr2res_pol_POL_SPEC_create().

◆ cr2res_dfs_POL_NULL_ERROR_colname()

char * cr2res_dfs_POL_NULL_ERROR_colname ( int  order_idx)

Get the POL_NULL_ERROR column name for a given order.

Parameters
order_idxThe order index (-49->50)
Returns
the column name or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 274 of file cr2res_dfs.c.

References cr2res_io_convert_order_idx_to_idxp().

Referenced by cr2res_pol_POL_SPEC_create().

◆ cr2res_dfs_POL_STOKES_colname()

char * cr2res_dfs_POL_STOKES_colname ( int  order_idx)

Get the POL_STOKES column name for a given order.

Parameters
order_idxThe order index (-49->50)
Returns
the column name or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 225 of file cr2res_dfs.c.

References cr2res_io_convert_order_idx_to_idxp().

Referenced by cr2res_pol_POL_SPEC_create().

◆ cr2res_dfs_POL_STOKES_ERROR_colname()

char * cr2res_dfs_POL_STOKES_ERROR_colname ( int  order_idx)

Get the POL_STOKES_ERROR column name for a given order.

Parameters
order_idxThe order index (-49->50)
Returns
the column name or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 241 of file cr2res_dfs.c.

References cr2res_io_convert_order_idx_to_idxp().

Referenced by cr2res_pol_POL_SPEC_create().

◆ cr2res_dfs_POL_WAVELENGTH_colname()

char * cr2res_dfs_POL_WAVELENGTH_colname ( int  order_idx)

Get the POL_WAVELENGTH column name for a given order.

Parameters
order_idxThe order index (-49->50)
Returns
the column name or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 209 of file cr2res_dfs.c.

References cr2res_io_convert_order_idx_to_idxp().

Referenced by cr2res_pol_POL_SPEC_create().

◆ cr2res_dfs_POSITIONX_colname()

char * cr2res_dfs_POSITIONX_colname ( int  order_idx,
int  trace 
)

Get the POSITIONX table column name for a given order/trace.

Parameters
order_idxThe order index (-49->50)
traceThe trace number (1->)
Returns
the column name or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 450 of file cr2res_dfs.c.

References cr2res_io_convert_order_idx_to_idxp().

Referenced by cr2res_extract_EXTRACT2D_create().

◆ cr2res_dfs_POSITIONY_colname()

char * cr2res_dfs_POSITIONY_colname ( int  order_idx,
int  trace 
)

Get the POSITIONY table column name for a given order/trace.

Parameters
order_idxThe order index (-49->50)
traceThe trace number (1->)
Returns
the column name or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 468 of file cr2res_dfs.c.

References cr2res_io_convert_order_idx_to_idxp().

Referenced by cr2res_extract_EXTRACT2D_create().

◆ cr2res_dfs_SENSITIVITY_colname()

char * cr2res_dfs_SENSITIVITY_colname ( int  order_idx,
int  trace 
)

Get the SENSITIVITY column name for a given order/trace.

Parameters
order_idxThe order index (-49->50)
traceThe trace number (1->)
Returns
the column name or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 342 of file cr2res_dfs.c.

References cr2res_io_convert_order_idx_to_idxp().

Referenced by cr2res_photom_engine().

◆ cr2res_dfs_set_groups()

cpl_error_code cr2res_dfs_set_groups ( cpl_frameset *  set)

Set the group as RAW or CALIB in a frameset.

Parameters
setthe input frameset
Returns
CPL_ERROR_NONE iff OK

Definition at line 53 of file cr2res_dfs.c.

◆ cr2res_dfs_SLIT_FRACTION_colname()

char * cr2res_dfs_SLIT_FRACTION_colname ( int  order_idx,
int  trace 
)

Get the SLIT_FRACTION table column name for a given order/trace.

Parameters
order_idxThe order index (-49->50)
traceThe trace number (1->)
Returns
the column name or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 486 of file cr2res_dfs.c.

References cr2res_io_convert_order_idx_to_idxp().

Referenced by cr2res_extract_EXTRACT2D_create().

◆ cr2res_dfs_SLIT_FUNC_colname()

char * cr2res_dfs_SLIT_FUNC_colname ( int  order_idx,
int  trace 
)

Get the SLIT_FUNC table column name for a given order/trace.

Parameters
order_idxThe order index (-49->50)
traceThe trace number (1->)
Returns
the column name or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 432 of file cr2res_dfs.c.

References cr2res_io_convert_order_idx_to_idxp().

Referenced by cr2res_extract_SLIT_FUNC_get_vector(), cr2res_extract_SLITFUNC_create(), and cr2res_qc_obs_slit_psf().

◆ cr2res_dfs_SPEC_colname()

char * cr2res_dfs_SPEC_colname ( int  order_idx,
int  trace 
)

Get the SPEC column name for a given order/trace.

Parameters
order_idxThe order index (-49->50)
traceThe trace number (1->)
Returns
the column name or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 378 of file cr2res_dfs.c.

References cr2res_io_convert_order_idx_to_idxp().

Referenced by cr2res_extract_EXTRACT1D_create(), cr2res_extract_EXTRACT1D_get_spectrum(), cr2res_extract_EXTRACT2D_create(), cr2res_qc_obs_nodding_signal(), and cr2res_qc_obs_nodding_standard_flux().

◆ cr2res_dfs_SPEC_colname_parse()

char * cr2res_dfs_SPEC_colname_parse ( const char *  colname,
int *  order_idx,
int *  trace 
)

Parse a column name ORDER_TRACE_TYPE format.

Parameters
colnameThe column name to parse
order_idx[out] The order index (-49->50)
trace[out] The trace number (1->)
Returns
the column TYPE or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 505 of file cr2res_dfs.c.

Referenced by cr2res_combine_extracted(), cr2res_idp_create_table(), cr2res_photom_engine(), cr2res_qc_flat_s2n(), and cr2res_util_blaze_stat().

◆ cr2res_dfs_SPEC_ERR_colname()

char * cr2res_dfs_SPEC_ERR_colname ( int  order_idx,
int  trace 
)

Get the ERR column name for a given order/trace.

Parameters
order_idxThe order index (-49->50)
traceThe trace number (1->)
Returns
the column name or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 414 of file cr2res_dfs.c.

References cr2res_io_convert_order_idx_to_idxp().

Referenced by cr2res_combine_extracted(), cr2res_extract_EXTRACT1D_create(), cr2res_extract_EXTRACT1D_get_spectrum(), cr2res_extract_EXTRACT2D_create(), and cr2res_qc_flat_s2n().

◆ cr2res_dfs_THROUGHPUT_colname()

char * cr2res_dfs_THROUGHPUT_colname ( int  order_idx,
int  trace 
)

Get the THROUGHPUT column name for a given order/trace.

Parameters
order_idxThe order index (-49->50)
traceThe trace number (1->)
Returns
the column name or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 360 of file cr2res_dfs.c.

References cr2res_io_convert_order_idx_to_idxp().

Referenced by cr2res_photom_engine().

◆ cr2res_dfs_WAVELENGTH_colname()

char * cr2res_dfs_WAVELENGTH_colname ( int  order_idx,
int  trace 
)

Get the WAVELENGTH column name for a given order/trace.

Parameters
order_idxThe order index (-49->50)
traceThe trace number (1->)
Returns
the column name or NULL in error case The return string needs to be deallocated with cpl_free()

Definition at line 396 of file cr2res_dfs.c.

References cr2res_io_convert_order_idx_to_idxp().

Referenced by cr2res_combine_extracted(), cr2res_extract_EXTRACT1D_create(), cr2res_extract_EXTRACT1D_get_spectrum(), cr2res_extract_EXTRACT2D_create(), cr2res_photom_engine(), and cr2res_qc_obs_nodding_standard_flux().