Documentation for /eve_analysis/ssw/ssw/sdo/eve/idl/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

./

eve_integrate_band.pro


top source eve_integrate_band

user

result = eve_integrate_band(irradiance_, b_wave, bandpass_ [, megsa=megsa] [, megsb=megsb] [, l2=l2] [, norm_val=norm_val] [, max_val=max_val] [, neg=neg])

Integrate the the irradiance over a given bandpass. Originally created with AIA bandpasses in mind.

You should set exactly one of /megsa, /megsb, and /l2. If none are set, the function will break. If more than one is set, the first one in the priority list /megsa, /megsb, /l2 is chosen.

This does an integration of the entire range of irradiance with instrument sensitivity weighting. This is a "band". If you need no instrument sensitivity and a limited range of wavelengths, use integrate_line().

This uses the Midpoint rule to integrate - Each bin is considered to be centered at its wavelength, and the measurement is considered to be the mean measurement over the bin.

Return value

integrated weighted measurement or absolute integrated weighted uncertainty in measurement across the given band. Since input is in (W/m^2)/nm, output is in W/m^2.

By default in the irradiance input, negative numbers are treated as fill values, and if any irradiances are negative where the bandpass is more tha 0.01, the data is presumed incomplete and a fill value -1 is returned. If /neg is set, fill values are set to zero and integrated normally, such that the absent values don't add to the total.

Parameters

irradiance_ in required

full array of irradiance from either MEGS A, MEGS B, or level 2 in (W/m^2)/nm

b_wave in required

wavelength scale of bandpass, in nm

bandpass_ in required

bandpass at each wavelength given

Keywords

megsa in optional

if set, input is on the MEGS A wavelength scale

megsb in optional

if set, input is on the MEGS B wavelength scale

l2 in optional

if set, input is on the Level 2 wavelength scale

norm_val in optional

Set this to a positive number to scale the bandpass such that the area under the bandpass is the given number.

max_val in optional

Set this to a positive number to scale the bandpass such that the max is the given number.

neg in optional

If set, treat fill values as zero and complete the integration regardless of the presence of fill data.

File attributes

Modification date: Fri Sep 14 00:00:00 2012
Lines: 97
Docformat: rst rst