Spectrum

class sbpy.spectroscopy.Spectrum(flux, dispersionaxis, unit)

Bases: object

Methods Summary

baseline([subtract])	fit baseline to Spectrum instance
convert_units(**kwargs)	Convert Spectrum units as provided by user
fit(spec)	Fit SpectralModel to different model types
integrated_flux(frequency[, interval])	Calculate integrated flux of emission line.
plot()	Plot spectrum
read(filename[, columns])	Read spectrum from file
slope([subtract])	fit slope to Spectrum instance
write(filename[, columns])	Write spectrum to file

Methods Documentation

baseline(subtract=False)

fit baseline to Spectrum instance

Parameters:

subtractbool, optional, default=False

if True, subtract the baseline

Returns:

float

Examples

>>> baseline = spec.baseline() 
>>> spec.baseline(subtract=True) 

not yet implemented

convert_units(**kwargs)

Convert Spectrum units as provided by user

Examples

>>> spec.convert_units(flux_unit=u.K) 
>>> spec.convert_units(dispersion_unit=u.km/u.s) 

not yet implemented

fit(spec)

Fit SpectralModel to different model types

Parameters:

specstr, mandatory

SpectralModel instance to fit

Examples

>>> spec_model = SpectralModel(type='Haser', molecule='H2O')  

>>> spec.fit(spec_model) 
>>> print(spec.fit_info) 

not yet implemented

integrated_flux(frequency, interval=<Quantity 1. km / s>)

Calculate integrated flux of emission line.

Parameters:

frequencyQuantity

Transition frequency

intervalQuantity

line width

Examples

>>> flux = spec.integrated_flux(frequency=556.9*u.GHz, 
>>>                             interval=1.7*u.km/u.s) 

not yet implemented

plot()

Plot spectrum

not yet implemented

classmethod read(filename, columns='auto')

Read spectrum from file

Parameters:

filenamestr, mandatory

data file name

columnsstr or list-like, optional, default: ‘auto’

file format, auto will try to recognize the format automatically

Returns:

Spectrum instance

Examples

>>> spec = Spectrum.read('2012_XY.dat') 

not yet implemented

slope(subtract=False)

fit slope to Spectrum instance

Parameters:

subtractbool, optional, default=False

if True, subtract the slope

Returns:

float

Examples

>>> slope = spec.slope() 
>>> spec.slope(subtract=True) 

not yet implemented

write(filename, columns='all')

Write spectrum to file

Parameters:

filenamestr, mandatory

data file name

columnsstr or list-like, optional: default: ‘all’

file format; all will write all fields to the file

Examples

>>> spec = Spectrum.read('2012_XY.dat') 
>>> spec.write('2012_XY.dat.bak') 

not yet implemented