CalibrateFiles or CF


The CalibrateFiles command facilitates the calibration of a folder containing Science images. It encompasses several parameters, some of which are mandatory, while others are optional. These parameters serve to specify the input requirements of the command.


It is advisable to review the explanations provided for the interactive Calibrate files operation. This will enhance your understanding of the CalibrateFiles command parameters and their respective functionalities:


    • ScienceFolder or -SF: specifies the location of the folder with Science images to be calibrated

    • CalibrationGroup or -CG: specifies the name of the Calibration Group to be used for calibrating Science images.  

    • CalibratedImagesFolder or -CIF: specifices the name of the subfolder to store calibrated images. This is an optional parameter, and the default value is "Calibrated"

    • UsedCalibrationImages or -UCI: specifies the name of the subfolder to store the calibration group images used during calibration. This is an optional parameter, and the default value is "Masterfiles"

    • CalibrationMethod or -CM: specifies the name of the calibration method to be used during image calibration. You can select between "Standard", "Advanced" or "Custom". More details are provided here. 

    • CustomCalibrationMethod or -CCM: if CalibrationMethod equals "Custom", this parameter allows to specify the selected Custom calibration method. Currently only one custom method is supported, called "FlatCalibrationOnly". This is an optional parameter, and the default value is "FlatCalibrationOnly".

    • Solve or -SOL: include this parameter if you want to solve images after calibration. This is an optional parameter and the default value is False.

    • Verbose or -V: this optional parameter has the default value True, indicating that the progress achieved during execution of the CalibrateFiles command will be displayed in the Command Prompt.

    • ErrorsOnly or -ERR: this optional parameter has the default value False. Set it to True if you want to limit the messages appearing in the Command Prompt to errors encountered during execution of the CalibrateFiles command.


Examples


  • Phoranso CalibrateFiles -SF "G:\My Astronomy CCDObs\2024\2024 03 15 XD\BY Cam" -CG "CBA XD Feb 2023 Calib Group" - CM "Advancded" - SOL False 


Calibrates all science images in the Science Folder "G:\My Astronomy CCDObs\2024\2024 03 15 XD\BY Cam\Sciences". Calibrated files will be stored in "G:\My Astronomy CCDObs\2024\2024 03 15 XD\BY Cam\Sciences\Calibrated".
Calibration will be done using master images stored in the calibration group "CBA XD Feb 2023 Calib Group", applying the Advanced calibration method. Calibrated images are not solved after calibration. The CalibrateFiles progress appears in the Command Prompt. 


  • Phoranso CalibrateFiles -SF "G:\My Astronomy CCDObs\2024\2024 03 15 XD\BY Cam" -CG "CBA XD Feb 2023 Calib Group" - CM "Custom" - SOL False


Same as above but calibration will be done using the "FlatCalibrationOnly" custom calibration method.