src/

amespahdbidlsuite_observation__define.pro

Class to hold an astronomical spectrum.

Updated versions of the NASA Ames PAH IR Spectroscopic Database and more information can be found at: www.astrochemistry.org/pahdb.

Examples

Create and destroy an AmesPAHdbIDLSuite_Observation-instance:

 IDL> obs = OBJ_NEW('AmesPAHdbIDLSuite_Observation')
 IDL> obs->Set,data
 IDL> obs->Plot
 IDL> OBJ_DESTROY,obs

Author information

Author

Dr. Christiaan Boersma

Copyright

BSD licensed

History

Changes:

 08-28-2024
 Honor NOTICE-keyword in ABSCISSAUNITSTO. Christiaan Boersma.
 06-15-2022:
 Properly include grid end point in REBIN. Christiaan Boersma.
 04-27-2022
 Added NOTICE-keyword and check for no abscissa units ABSCISSAUNITSTO.
 Christiaan Boersma.
 04-30-2021
 Fix parsing of ASCII-files and Accommodate IPAC tables.
 Sort data when chaning units. Christiaan Boersma.
 07-07-2016
 Removed extraneous spaces after last column when writing to file
 in WRITE. Now using TEMPORARY where appropriate. Christiaan Boersma.
 04-21-2016
 Added Resolution keyword to REBIN. Added message to
 ReadFromFITSFile and ReadFromTextFile printing filename. Fixed bug
 in Init not handeling input struct correctly. Christiaan Boersma.
 03-18-2016
 Fixed bug in ReadFromFile using now '->' instead of
 '.'. Christiaan Boersma.
 11-05-2015
 Fixed REBIN to handle data outside original grid. Christiaan Boersma.
 05-03-2015
 Reading from file will now honor overriding keywords in
 SET. Christiaan Boersma.
 04-07-2015
 Added SETGRIDRANGE. Christiaan Boersma.
 01-28-2015
 First version of the file. Christiaan Boersma.

Class description for AmesPAHdbIDLSuite_Observation

Inheritance

AmesPAHdbIDLSuite_Plot

Properties

Properties in AmesPAHdbIDLSuite_Observation

Continuum init
ErrX init
ErrY init
Header init
Units init
X init
Y init

Routines

Routines from amespahdbidlsuite_observation__define.pro

AmesPAHdbIDLSuite_Observation::Plot [, Stick=int] [, Fill=int] [, Oplot=int] [, Color=int] [, _EXTRA=struct]: Plot the astronomical spectrum.
AmesPAHdbIDLSuite_Observation::Write [, Filename]: Write the astronomical spectrum to file as an IPAC-table.
AmesPAHdbIDLSuite_Observation::AbscissaUnitsTo [, xunit], Notice=Notice: Convert abscissa units.
AmesPAHdbIDLSuite_Observation::Rebin [, x] [, Uniform=int] [, Resolution=int]: Rebin astronomical spectrum.
AmesPAHdbIDLSuite_Observation::ReadFromFile, Filename [, Units=AmesPAHdb_Observation_Units_S]: Read astronomical spectrum from a file.
AmesPAHdbIDLSuite_Observation::SetGridRange, min, max: Truncates the data to the given range.
result = AmesPAHdbIDLSuite_Observation::GetGrid(): Retrieves the abscissa values.
result = AmesPAHdbIDLSuite_Observation::Get(): Retrieves the AmesPAHdbIDLSuite_Observation representation in a structure.
AmesPAHdbIDLSuite_Observation::Set [, Struct] [, X=float array (1D)] [, Y=float array (1D)] [, ErrX=float array (1D)] [, ErrY=float array (1D)] [, Continuum=float array (1D)] [, Units=AmesPAHdb_Observation_Units_S] [, Header=string array (1D)]: Populates the AmesPAHdbIDLSuite_Observation-instance.
result = AmesPAHdbIDLSuite_Observation::Init( [Struct] [, X=float array (1D)] [, Y=float array (1D)] [, ErrX=float array (1D)] [, ErrY=float array (1D)] [, Continuum=float array (1D)] [, Units=AmesPAHdb_Observation_Units_S] [, Header=string array (1D)]): Create an AmesPAHdbIDLSuite_Observation-instance

Routine details

top source AmesPAHdbIDLSuite_Observation::Plot

PLOTTING

AmesPAHdbIDLSuite_Observation::Plot [, Stick=int] [, Fill=int] [, Oplot=int] [, Color=int] [, _EXTRA=struct]

Plot the astronomical spectrum.

Keywords

Stick in optional type=int

Whether to plot the spectrum as sticks

Fill in optional type=int

Whether to solid-fill the spectrum

Oplot in optional type=int

Whether to draw over a previous plot

Color in optional type=int

Color to plot the spectrum with

_EXTRA in optional type=struct

Required for IDL's keyword-inheritance mechanism

top source AmesPAHdbIDLSuite_Observation::Write

OUTPUT

AmesPAHdbIDLSuite_Observation::Write [, Filename]

Write the astronomical spectrum to file as an IPAC-table.

Parameters

Filename in optional type=string

Output filename

top source AmesPAHdbIDLSuite_Observation::AbscissaUnitsTo

MANIPULATE

AmesPAHdbIDLSuite_Observation::AbscissaUnitsTo [, xunit], Notice=Notice

Convert abscissa units.

Parameters

xunit in optional type=int

Type to convert to

Keywords

Notice

top source AmesPAHdbIDLSuite_Observation::Rebin

MANIPULATE

AmesPAHdbIDLSuite_Observation::Rebin [, x] [, Uniform=int] [, Resolution=int]

Rebin astronomical spectrum.

Parameters

x in optional type=float array

Either grid, grid spacing or resolution depending on the set keywords

Keywords

Uniform in optional type=int

Whether to generate a equally spaced grid

Resolution in optional type=int

Whether to generate a grid with a fixed resolution

top source AmesPAHdbIDLSuite_Observation::ReadFromFile

INPUT

AmesPAHdbIDLSuite_Observation::ReadFromFile, Filename [, Units=AmesPAHdb_Observation_Units_S]

Read astronomical spectrum from a file.

Parameters

Filename required type=string

File to read

Keywords

Units in optional type=AmesPAHdb_Observation_Units_S

Units describing structure

top source AmesPAHdbIDLSuite_Observation::SetGridRange

SET/GET

AmesPAHdbIDLSuite_Observation::SetGridRange, min, max

Truncates the data to the given range.

Parameters

min required type=flaot

Minimum abscissa value

max required type=float

Maximum abscissa value

top source AmesPAHdbIDLSuite_Observation::GetGrid

SET/GET

result = AmesPAHdbIDLSuite_Observation::GetGrid()

Retrieves the abscissa values.

Return value

float array

top source AmesPAHdbIDLSuite_Observation::Get

SET/GET

result = AmesPAHdbIDLSuite_Observation::Get()

Retrieves the AmesPAHdbIDLSuite_Observation representation in a structure.

Return value

Structure

top source AmesPAHdbIDLSuite_Observation::Set

SET/GET

AmesPAHdbIDLSuite_Observation::Set [, Struct] [, X=float array (1D)] [, Y=float array (1D)] [, ErrX=float array (1D)] [, ErrY=float array (1D)] [, Continuum=float array (1D)] [, Units=AmesPAHdb_Observation_Units_S] [, Header=string array (1D)]

Populates the AmesPAHdbIDLSuite_Observation-instance.

Parameters

Struct in optional type=struct

Data structure

Keywords

X in optional type=float array (1D)

Abscissa values

Y in optional type=float array (1D)

Ordinate values

ErrX in optional type=float array (1D)

Uncertainties associated with the abscissa values

ErrY in optional type=float array (1D)

Uncertainties associated with the ordinate values

Continuum in optional type=float array (1D)

Continuum values

Units in optional type=AmesPAHdb_Observation_Units_S

Units describing structure

Header in optional type=string array (1D)

FITS header associated with the data

top source AmesPAHdbIDLSuite_Observation::Init

CLASS

result = AmesPAHdbIDLSuite_Observation::Init( [Struct] [, X=float array (1D)] [, Y=float array (1D)] [, ErrX=float array (1D)] [, ErrY=float array (1D)] [, Continuum=float array (1D)] [, Units=AmesPAHdb_Observation_Units_S] [, Header=string array (1D)])

Create an AmesPAHdbIDLSuite_Observation-instance

Return value

AmesPAHdbIDLSuite_Observation-instance

Parameters

Struct in optional type=struct

Data structure

Keywords

X in optional type=float array (1D)

Abscissa values

Y in optional type=float array (1D)

Ordinate values

ErrX in optional type=float array (1D)

Uncertainties associated with the abscissa values

ErrY in optional type=float array (1D)

Uncertainties associated with the ordinate values

Continuum in optional type=float array (1D)

Continuum values

Units in optional type=AmesPAHdb_Observation_Units_S

Units describing structure

Header in optional type=string array (1D)

FITS header associated with the data

File attributes

Modification date:	Fri Oct 24 12:51:08 2025
Lines:	523
Docformat:	rst rst