Package ivs :: Package catalogs :: Module hermes :: Class HermesCCF

Class HermesCCF

Object that holds all information stored in the *_AllCCF.fits files written by hermesVR. The original information is stored in the following variables that can be accessed directly:

filename: The path to the *_AllCCF.fits file
header: The header of the original spectra that was the input to hermesVR
groups: The summary that hermesVR prints of the 5 preset order groups stored as a rec array
ccfs: All cross-correlation functions stored as a array (index 0-54)
vr: the velocity scale of the cross correlation functions (array)

Appart from these attributes, two functions allow you to read the ccf by order or a list of orders where the order numbers are the original hermes orders (40-94).

Instance Methods

[hide private]

__init__(self, filename=None)
Read the provided file and store all information.

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Interaction

array

ccf(self, order)
Return the ccf function belonging to the requested order.

source code

array

combine_ccf(self, orders)
Sum the ccf function belonging to the requested order numbers.

source code

Internal

_read_file(self, filename)
Read the *_AllCCF.fits file

source code

__str__(self)
String representation of this object

source code

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, filename=None)
(Constructor)

source code

Read the provided file and store all information.

Parameters:

filename (string) - The complete path to the AllCCF.fits file to read.

Overrides: object.__init__

ccf(self, order)

source code

Return the ccf function belonging to the requested order. The order number is the real order number (40 <= order <= 94).

Parameters:

order (int) - The hermes order of which you want the ccf

Returns: array

The cross correlation function of the requested order

Raises:

IndexError - When the order is out of bounds.

combine_ccf(self, orders)

source code

Sum the ccf function belonging to the requested order numbers. The order numbers can be given as a list of integers or in a string representation. When using the string representation, you can use the ':' sign to give a range of order which will include the starting and ending order. Fx the following two commands will return the same summed ccf:

>>> combine_ccf([54,55,56,57,75,76])
>>> combine_ccf('54:57,75,76')

Parameters:

orders (list or string) - The hermes orders of which you want the summed ccf

Returns: array

The summed cross correlation function of the requested orders

Raises:

IndexError - When an order is out of bounds.

str(self)
(Informal representation operator)

source code

String representation of this object

Overrides: object.__str__

Class HermesCCF

__init__(self, filename=None) (Constructor)

ccf(self, order)

combine_ccf(self, orders)

__str__(self) (Informal representation operator)

init(self, filename=None)
(Constructor)

str(self)
(Informal representation operator)