![[attach.png]](../idldoc-resources/attach.png)
src/
amespahdbidlsuite_coadded_spectrum__define.pro
Class to manage a co-added spectrrum.
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_CoAdded_Spectrum-instance:
IDL> coadded = OBJ_NEW('AmesPAHdbIDLSuite_Coadded_Spectrum')
IDL> OBJ_DESTROY,coadded
Author information
- Author
Dr. Christiaan Boersma
- Copyright
BSD licensed
- History
Changes:
04-30-2021 Remove duplicated SET and CLEANUP methods. Christiaan Boersma. 12-13-2018 Now writing files as IPAC-tables. Christiaan Boersma. 05-03-2015 Updated weights formatting for DESCRIPTION. Christiaan Boersma. 02-01-2015 First version of the file. Christiaan Boersma.
Class description for AmesPAHdbIDLSuite_Coadded_Spectrum
Inheritance
All ancestor classes: AmesPAHdbIDLSuite_Spectrum AmesPAHdbIDLSuite_Plot AmesPAHdbIDLSuite_Data IDL_Object
Properties
Properties in AmesPAHdbIDLSuite_Coadded_Spectrum
- Averaged init
- Data init
- FWHM init
- Grid init
- Model init
- PAHdb init
- Profile init
- Shift init
- Type init
- Uids init
- Units init
- Version init
- Weights init
Routines
Methods inherited from AmesPAHdbIDLSuite_Spectrum
result = AmesPAHdbIDLSuite_Spectrum::Init( [Struct] [, Type=string] [, Version=string] [, Data=struct] [, PAHdb=pointer] [, Uids=long array (1D)] [, Model=string] [, Units=AmesPAHdb_Units_S struct] [, Shift=float] [, Grid=float array] [, Profile=string] [, FWHM=float])AmesPAHdbIDLSuite_Spectrum::Description [, Str]AmesPAHdbIDLSuite_Spectrum::Set [, Struct] [, Type=string] [, Version=string] [, Data=struct] [, PAHdb=pointer] [, Uids=long array (1D)] [, Model=string] [, Units=AmesPAHdb_Units_S struct] [, Shift=float] [, Grid=float array] [, Profile=string] [, FWHM=float]result = AmesPAHdbIDLSuite_Spectrum::Fit(observation [, error] [, TOLERANCE_NNLS=double] [, MAXITER_NNLS=long] [, /CALLBACK_NNLS] [, EXTERNAL_NNLS=int] [, Notice=int])result = AmesPAHdbIDLSuite_Spectrum::Get()result = AmesPAHdbIDLSuite_Spectrum::GetGrid()AmesPAHdbIDLSuite_Spectrum::Resample, gridAmesPAHdbIDLSuite_Spectrum::Plot [, Wavelength=int] [, Stick=int] [, Fill=int] [, Oplot=int] [, Legend=int] [, Color=int] [, _EXTRA=struct]AmesPAHdbIDLSuite_Spectrum::Write [, Filename]result = AmesPAHdbIDLSuite_Spectrum::MCFit(observation, error, samples [, TOLERANCE_NNLS=double] [, MAXITER_NNLS=long] [, EXTERNAL_NNLS=int] [, Uniform=int])result = AmesPAHdbIDLSuite_Spectrum::Coadd( [Weights=struct] [, Average=int])
Routines from amespahdbidlsuite_coadded_spectrum__define.pro
AmesPAHdbIDLSuite_Coadded_Spectrum::Description [, Str]Output spectrum description.
AmesPAHdbIDLSuite_Coadded_Spectrum::Plot [, Wavelength=int] [, Stick=int] [, Fill=int] [, Oplot=int] [, Legend=int] [, Color=int] [, _EXTRA=struct]Plot the coadded spectrum.
AmesPAHdbIDLSuite_Coadded_Spectrum::Write [, Filename]Write the co-added spectrum to file as an IPAC-table.
result = AmesPAHdbIDLSuite_Coadded_Spectrum::Get()Retrieves the AmesPAHdbIDLSuite_CoAdded_Spectrum representation in a structure.
AmesPAHdbIDLSuite_Coadded_Spectrum::Set [, Struct] [, Type=string] [, Version=string] [, Data=struct] [, PAHdb=pointer] [, Uids=long array (1D)] [, Model=string] [, Units=AmesPAHdb_Units_S struct] [, Shift=float] [, Grid=float array] [, Profile=string] [, FWHM=float] [, Weights=struct] [, Averaged=int]Populates the AmesPAHdbIDLSuite_CoAdded_Spectrum-instance.
result = AmesPAHdbIDLSuite_Coadded_Spectrum::Init( [Struct] [, Type=string] [, Version=string] [, Data=struct] [, PAHdb=pointer] [, Uids=long array (1D)] [, Model=string] [, Units=AmesPAHdb_Units_S struct] [, Shift=float] [, Grid=float array] [, Profile=string] [, FWHM=float] [, Weights=struct] [, Averaged=int])Create an AmesPAHdbIDLSuite_Coadded_Spectrum-instance
Routine details
top source AmesPAHdbIDLSuite_Coadded_Spectrum::Description
INFORMATIVE
AmesPAHdbIDLSuite_Coadded_Spectrum::Description [, Str]
Output spectrum description.
Parameters
- Str out optional type=string array
Ouput to Str
top source AmesPAHdbIDLSuite_Coadded_Spectrum::Plot
PLOTTING
AmesPAHdbIDLSuite_Coadded_Spectrum::Plot [, Wavelength=int] [, Stick=int] [, Fill=int] [, Oplot=int] [, Legend=int] [, Color=int] [, _EXTRA=struct]
Plot the coadded spectrum.
Keywords
- Wavelength in optional type=int
Whether to set the abscissa units to wavelength
- 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 over-plot the spectrum on a previous defined plot
- Legend in optional type=int default=1B
Whether to show a legend
- 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_Coadded_Spectrum::Write
OUTPUT
AmesPAHdbIDLSuite_Coadded_Spectrum::Write [, Filename]
Write the co-added spectrum to file as an IPAC-table.
Parameters
- Filename in optional type=string
Output filename
top source AmesPAHdbIDLSuite_Coadded_Spectrum::Get
SET/GET
result = AmesPAHdbIDLSuite_Coadded_Spectrum::Get()
Retrieves the AmesPAHdbIDLSuite_CoAdded_Spectrum representation in a structure.
Return value
Structure
top source AmesPAHdbIDLSuite_Coadded_Spectrum::Set
SET/GET
AmesPAHdbIDLSuite_Coadded_Spectrum::Set [, Struct] [, Type=string] [, Version=string] [, Data=struct] [, PAHdb=pointer] [, Uids=long array (1D)] [, Model=string] [, Units=AmesPAHdb_Units_S struct] [, Shift=float] [, Grid=float array] [, Profile=string] [, FWHM=float] [, Weights=struct] [, Averaged=int]
Populates the AmesPAHdbIDLSuite_CoAdded_Spectrum-instance.
Parameters
- Struct in optional type=struct
Data structure
Keywords
- Type in optional type=string
Type of Data
- Version in optional type=string
Versioning information
- Data in optional type=struct
Data structure
- PAHdb in optional type=pointer
Pointer to parsed database file
- Uids in optional type=long array (1D)
UIDs in Data
- Model in optional type=string
References
- Units in optional type=AmesPAHdb_Units_S struct
Comments
- Shift in optional type=float
Shift
- Grid in optional type=float array
Grid
- Profile in optional type=string
Profile
- FWHM in optional type=float
FWHM
- Weights in optional type=struct
Weights
- Averaged in optional type=int
Whether the spectra were averaged
top source AmesPAHdbIDLSuite_Coadded_Spectrum::Init
CLASS
result = AmesPAHdbIDLSuite_Coadded_Spectrum::Init( [Struct] [, Type=string] [, Version=string] [, Data=struct] [, PAHdb=pointer] [, Uids=long array (1D)] [, Model=string] [, Units=AmesPAHdb_Units_S struct] [, Shift=float] [, Grid=float array] [, Profile=string] [, FWHM=float] [, Weights=struct] [, Averaged=int])
Create an AmesPAHdbIDLSuite_Coadded_Spectrum-instance
Return value
AmesPAHdbIDLSuite_Data-instance
Parameters
- Struct in optional type=struct
Data structure
Keywords
- Type in optional type=string
Type of Data
- Version in optional type=string
Versioning information
- Data in optional type=struct
Data structure
- PAHdb in optional type=pointer
Pointer to parsed database file
- Uids in optional type=long array (1D)
UIDs in Data
- Model in optional type=string
References
- Units in optional type=AmesPAHdb_Units_S struct
Comments
- Shift in optional type=float
Shift
- Grid in optional type=float array
Grid
- Profile in optional type=string
Profile
- FWHM in optional type=float
FWHM
- Weights in optional type=struct
Weights
- Averaged in optional type=int
Whether the spectra were averaged
File attributes
| Modification date: | Fri Oct 24 12:51:06 2025 |
| Lines: | 148 |
| Docformat: | rst rst |