Table Of Contents

Previous topic

The sinfo_rec_pupil recipe

Next topic

The sinfo_utl_ima_line_corr recipe

This Page

The sinfo_utl_cube2spectrum recipe

sinfo_utl_cube2spectrum

Synopsis

Collapse a cube to an image over an aperture

Description

This recipe performs cube to 1D spectrum image conversion.

The input files is a cube Its associated tag should be CUBE.

The output is an image resulting from the cube manipulated according to the value of op Over an aperture as specified by the parameter sinfoni.sinfo_utl_cube2spectrum.aperture having alias ‘op’, ‘ap’Information on relevant parameters can be found with esorex –params sinfo_utl_cube2spectrum esorex –help sinfo_utl_cube2spectrum

Constructor

cpl.Recipe("sinfo_utl_cube2spectrum")

Create an object for the recipe sinfo_utl_cube2spectrum.

import cpl
sinfo_utl_cube2spectrum = cpl.Recipe("sinfo_utl_cube2spectrum")

Parameters

sinfo_utl_cube2spectrum.param.op

A possible operation: average, clean_mean, median, sum (str; default: ‘average’) [default=”average”].

sinfo_utl_cube2spectrum.param.ap

A possible aperture: rectangle, circle (str; default: ‘rectangle’) [default=”rectangle”].

sinfo_utl_cube2spectrum.param.llx

Lower left X rectangle coordinate (long; default: 2) [default=2].

sinfo_utl_cube2spectrum.param.lly

Lower left Y rectangle coordinate (long; default: 2) [default=2].

sinfo_utl_cube2spectrum.param.urx

Upper right X rectangle coordinate (long; default: 28) [default=28].

sinfo_utl_cube2spectrum.param.ury

Upper right Y rectangle coordinate (long; default: 28) [default=28].

sinfo_utl_cube2spectrum.param.lo_rej

Clean mean low rejection (long; default: 10) [default=10].

sinfo_utl_cube2spectrum.param.hi_rej

Clean mean low rejection (long; default: 10) [default=10].

sinfo_utl_cube2spectrum.param.centerx

Circle center X coordinate (long; default: 16) [default=16].

sinfo_utl_cube2spectrum.param.centery

Circle center Y coordinate (long; default: 16) [default=16].

sinfo_utl_cube2spectrum.param.radius

Circle radii (long; default: 5) [default=5].

The following code snippet shows the default settings for the available parameters.

import cpl
sinfo_utl_cube2spectrum = cpl.Recipe("sinfo_utl_cube2spectrum")

sinfo_utl_cube2spectrum.param.op = "average"
sinfo_utl_cube2spectrum.param.ap = "rectangle"
sinfo_utl_cube2spectrum.param.llx = 2
sinfo_utl_cube2spectrum.param.lly = 2
sinfo_utl_cube2spectrum.param.urx = 28
sinfo_utl_cube2spectrum.param.ury = 28
sinfo_utl_cube2spectrum.param.lo_rej = 10
sinfo_utl_cube2spectrum.param.hi_rej = 10
sinfo_utl_cube2spectrum.param.centerx = 16
sinfo_utl_cube2spectrum.param.centery = 16
sinfo_utl_cube2spectrum.param.radius = 5

You may also set or overwrite some or all parameters by the recipe parameter param, as shown in the following example:

import cpl
sinfo_utl_cube2spectrum = cpl.Recipe("sinfo_utl_cube2spectrum")
[...]
res = sinfo_utl_cube2spectrum( ..., param = {"op":"average", "ap":"rectangle"})

See also

cpl.Recipe for more information about the recipe object.

Bug reports

Please report any problems to Andrea Modigliani. Alternatively, you may send a report to the ESO User Support Department.