flystar.template
Functions
|
Base example of how to use the flystar code. Assumes we are transforming a label.dat into |
Module Contents
- flystar.template.align_template(labelFile, reference, transModel=transforms.PolyTransform, order=1, N_loop=2, dr_tol=1.0, dm_tol=None, briteN=100, weights='both', restrict=False, outFile='outTrans.txt')
Base example of how to use the flystar code. Assumes we are transforming a label.dat into a reference starlist.
Parameters:
- labelFile: ascii file
Starlist we would like to transform into the reference frame. For this code, we expect a label.dat file
- reference: ascii file
Starlist that defines the reference frame
- transModel: transformation class (default: transforms.polyTransform)
Defines which transformation model to use. Both the four-parameter and polynomial transformations are supported
- order: int (default=1)
Order of the polynomial transformation. Only used for polynomial transform
- N_loop: int (default=2)
How many times to iterate on the transformation calculation. Ideally, each iteration adds more stars and thus a better transform, to some limit.
- dr_tol: float(default=1.0)
the distance tolerance for matching two stars in align.transform_and_match
- dm_tol: float (defalut=None)
the magnitude tolerance for matching two stars in align.trnasform_and_match
- briteN: int (default=100)
the number of stars used in blind matching
- weights: string (default=’both’)
- if weights==’both’, we use both position error in transformed starlist and
reference starlist as uncertanty. And weights is the reciprocal of this uncertanty.
if weights==’starlist’, we only use postion error in transformed starlist. if weights==’reference’, we only use position error in reference starlist. if weights==None, we don’t use weights.
- restrict: boolean (default=False)
Set to True if transformation restricted to stars with use > 2.
- outFile: string(‘outTrans.txt’)
the name of the output transformation file