The Solar-Stellar Spectrograph

[ Home | About | Tech Info & Data | Publications | References ]      [ Site by Jeffrey Hall | Research funded by NSF ]

ScatteredLight

The ScatteredLight class removes a scattered light surface from a data frame. It inherits ReduceTool. As with all the reducer objects, ScatteredLight implements methods that set up the various relevant quantities, and a go method that does the actual work. The code samples presented in the documentation below presuppose familiarity with IDL programming and syntax.

Version History

2008 July 25 - Documentation written.

Data Members

float orderWidth

int orderStart

pointer ordMap

pointer lightSurf

Method List

cleanup

define

get_lightsurf( )

go

init( )

load_ordermap

set_order_start

set_order_width

store_frame

store_lightsurf

Method Descriptions

PRO cleanup

Calls ReduceTool::cleanup

Destructor. Calls ReduceTool::cleanup and then frees its own data member pointers. Never call this procedure directly; it is invoked by IDL's Obj_Destroy function.

PRO define

Structure definition. Specifies the contents of the IDL structure instantiated by the ScatteredLight class. Used by Obj_New; do not invoke directly.

FUNCTION get_lightsurf

Return pointer lightSurf

Returns a the object's lightSurf data member, which is a pointer to a float array holding the 2D scattered light surface. For SSS data, the dimensions of the array are 512 x 400.

PRO go

Calls Root::add_history

Removes scattered light from the data frame.

FUNCTION init

keyword bool verbose

Return bool TRUE, FALSE

Constructor. If the keyword verbose is set, the verbose data member (inherited from Tool) is set to TRUE. Never call this function directly; it is invoked by IDL's Obj_New function.

PRO load_ordermap

argument string f

argument int ordLength

argument int numOrders

Loads the contents of the file f.ordmap into the object's ordMap data member. This is an array of floats containing the centroids of each pixel in each order, the principal output of the Ordermap class. For SSS data, it has dimensions [512,20].

PRO set_order_start

argument int o

Sets the value of the object's orderStart data member. This is an SSS-specific function that causes scattered light removal to be applied only to orders at or above orderStart. We only apply scattered light removal to the echelle frame, since what scattered light exists in the single-order blue frame is removed by the debiasing step. Since the blue frame is grafted onto the red frame to combine the whole SSS observation into one image, we need to disable scattered light removal for that order only.

PRO set_order_width

argument float width

Sets the value of the object's orderWidth data member.

PRO store_frame

argument string f

Writes the data data member to the file f.dsc.

PRO store_lightsurf

argument string f

Writes the lightSurf data member to the file f.sctlt.

[Back to contents]