Tycho Lua Plugin Host API

This document lists all host-side API functions available to Lua plugins.

core
images
- get_count
- run_script_on_dir
- load
- save
- cleanup
- reset_file_list
- add_output
- calibrate
- debayer
- resize
- plate_solve
- align
- drizzle
- evaluate
- inject_targets
- shuffle
- merge
- get_dir_images
- get_path_image
- attach_ephemeris
- larson_sekanina
- get_crosshair_x
- get_crosshair_y
- reset_view
tracker
kvp
- load

core

get_version

Signature: int get_version()

Version: 1.0 Since: 13.0

Lua: host.get_version()

Returns the Tycho version identifier (13100 = v13.1)

set_active_observatory_by_id

Signature: bool set_active_observatory_by_id()

Version: 1.0 Since: 13.0

Lua: host.set_active_observatory_by_id()

Sets the active observatory by identifier

set_active_observatory_by_obs_code

Signature: bool set_active_observatory_by_obs_code()

Version: 1.0 Since: 13.0

Lua: host.set_active_observatory_by_obs_code()

Sets the active observatory by MPC code

set_active_observatory_by_label

Signature: bool set_active_observatory_by_label()

Version: 1.0 Since: 13.0

Lua: host.set_active_observatory_by_label()

Sets the active observatory by label

add

Signature: double add()

Version: 1.0 Since: 13.0

Lua: host.add()

Returns the sum of two numbers

subtract

Signature: double subtract()

Version: 1.0 Since: 13.0

Lua: host.subtract()

Returns the difference of two numbers

sleep

Signature: void sleep(double)

Version: 1.0 Since: 13.0

Lua: host.sleep()

Sleeps for specified number of milliseconds

log

Signature: void log(msg)

Version: 1.0 Since: 13.0

Lua: host.log()

Prints a message to the log window

msgbox

Signature: void msgbox(text, caption)

Version: 1.0 Since: 13.0

Lua: host.msgbox()

Displays a message box with the supplied text and caption

get_path_script

Signature: string get_path_script()

Version: 1.0 Since: 13.0

Lua: host.get_path_script()

Returns the full path to the current script file

get_dir_script

Signature: string get_dir_script()

Version: 1.0 Since: 13.0

Lua: host.get_dir_script()

Returns the full path to the directory containing the current script

exit

Signature: void exit()

Version: 1.0 Since: 13.0

Lua: host.exit()

Quits the current Tycho instance

get_parent_dir

Signature: string get_parent_dir(string input_dir)

Version: 1.0 Since: 13.0

Lua: host.get_parent_dir()

Returns the full path to the parent directory

images

get_count

Signature: int get_count()

Version: 1.0 Since: 13.0

Lua: host.images.get_count()

Returns the number of loaded images

run_script_on_dir

Signature: void run_script_on_dir(path_script, path_dir, bkgnd_mode)

Version: 1.0 Since: 13.0

Lua: host.images.run_script_on_dir()

Spawns a new Tycho instance to run a specified script on a specified directory of images.

load

Signature: void load(function callback)

Version: 1.0 Since: 13.0

Lua: host.images.load()

Loads the images into memory

save

Signature: void save(function callback, bool remove_wcs)

Version: 1.0 Since: 13.0

Lua: host.images.save()

Saves the images to disk

cleanup

Signature: void cleanup(function callback)

Version: 1.0 Since: 13.0

Lua: host.images.cleanup()

Performs cleanup of image processing

reset_file_list

Signature: void reset_file_list(function callback, bool clear_list)

Version: 1.0 Since: 13.0

Lua: host.images.reset_file_list()

Resets image list

add_output

Signature: void add_output(function callback)

Version: 1.0 Since: 13.0

Lua: host.images.add_output()

Adds output images

calibrate

Signature: void calibrate(function callback)

Version: 1.0 Since: 13.0

Lua: host.images.calibrate()

Performs calibration on the active image set

Available inputs:

Name	Type	Values
`Path_Bias`	string	—
`Path_Dark`	string	—
`Path_Flat`	string	—
`Mode_Bias`	integer	`SKIP`=0, `SUPPLY`=1
`Mode_Dark`	integer	`SKIP`=0, `APPLY`=1, `AUTO`=2
`Mode_Flat`	integer	`SKIP`=0, `APPLY`=1, `AUTO`=2
`Calibrate_Dark`	boolean	—
`Scale_Dark`	boolean	—
`Calibrate_Flat`	boolean	—
`Apply_Pseudo_Flat`	boolean	—
`Apply_Normalization`	boolean	—
`Apply_Fix_Pixels`	boolean	—
`Apply_Fix_Lines`	boolean	—
`Invert_Pixels`	boolean	—
`Apply_Scale_ADU`	boolean	—
`Scale_Factor_ADU`	number	—
`Apply_Pedestal_ADU`	boolean	—
`Pedestal_Amount_ADU`	number	—
`Override_Output_Dir`	boolean	—
`Path_Output_Dir`	string	—

debayer

Signature: void debayer(function callback)

Version: 1.0 Since: 13.0

Lua: host.images.debayer()

Performs debayer on the active image set

Name	Type	Values
`Pattern`	integer	`AUTO`=0, `RGGB`=1, `BGGR`=2, `GBRG`=3, `GRBG`=4, `GRGB`=5, `GBGR`=6, `RGBG`=7, `BGRG`=8
`Output`	integer	`COMBINED_LUMINANCE`=0, `SPLIT_RGB`=1
`Mode`	integer	`SUPERPIXEL`=0, `BILINEAR`=1, `VNG`=2
`Override_Output_Dir`	boolean	—
`Path_Output_Dir`	string	—

resize

Signature: void resize(function callback)

Version: 1.0 Since: 13.0

Lua: host.images.resize()

Performs resizing on the active image set

Available inputs:

Name	Type	Values
`Desired_Width`	integer	—
`Desired_Height`	integer	—
`Crop_Top`	integer	—
`Crop_Right`	integer	—
`Crop_Bottom`	integer	—
`Crop_Left`	integer	—
`Bin_Amount`	integer	—
`Horz_Divisions`	integer	—
`Vert_Divisions`	integer	—
`Unit_Percent`	boolean	—
`Override_Output_Dir`	boolean	—
`Path_Output_Dir`	string	—

plate_solve

Signature: void plate_solve(function callback)

Version: 1.0 Since: 13.0

Lua: host.images.plate_solve()

Plate solves the active image set

Available inputs:

Name	Type	Values
`Scale_Lower`	number	—
`Scale_Upper`	number	—
`Mode_Extraction`	integer	`AUTO`=0, `STANDARD`=1, `EXTENDED`=2
`Downsample`	integer	`AUTO`=0, `F1`=1, `F2`=2, `F3`=3, `F4`=4, `F5`=5, `F6`=6, `F7`=7, `F8`=8, `F9`=9, `F10`=10
`Reference_Image`	integer	`AUTO`=0, `FIRST`=1, `MIDDLE`=2, `LAST`=3
`Only_Reference`	boolean	—
`Narrow_Search`	boolean	—
`Search_Radius`	number	—

align

Signature: void align(function callback)

Version: 1.0 Since: 13.0

Lua: host.images.align()

Aligns the active image set

Available inputs:

Name	Type	Values
`Interpolation`	integer	`BILINEAR`=100, `BICUBIC`=101, `LANCZOS3`=102, `LANCZOS4`=103, `LANCZOS5`=104
`Mode`	integer	`STARMATCH`=100, `WCS`=101
`Downsample`	integer	—
`Dist_Corr`	boolean	—
`Override_Output_Dir`	boolean	—
`Path_Output_Dir`	string	—

drizzle

Signature: void drizzle(function callback)

Version: 1.0 Since: 13.0

Lua: host.images.drizzle()

Performs drizzle on the active image set

Available inputs:

Name	Type	Values
`Ref_Img`	integer	`AUTO`=0, `FIRST`=1, `MIDDLE`=2, `LAST`=3
`Method`	integer	`AVERAGE`=0, `MEDIAN`=1
`Output`	integer	`BY_FILTER`=0, `COMBINE_ALL`=1
`Scale`	integer	—
`Override_Output_Dir`	boolean	—
`Path_Output_Dir`	string	—

evaluate

Signature: void evaluate(function callback)

Version: 1.0 Since: 13.0

Lua: host.images.evaluate()

Evaluates the active image set

Available inputs:

Name	Type	Values
`T1_PS`	number	—
`T2_PS`	number	—
`T1_SM`	number	—
`T2_SM`	number	—
`T1_IS`	number	—
`T2_IS`	number	—
`Update_FITS_Header`	boolean	—
`Allow_Abort`	boolean	—
`Abort_PS`	boolean	—
`Abort_SM`	boolean	—
`Abort_IS`	boolean	—
`Target_SNR`	number	—
`Override_Output_Dir`	boolean	—
`Path_Output_Dir`	string	—

inject_targets

Signature: void inject_targets(function callback)

Version: 1.0 Since: 13.0

Lua: host.images.inject_targets()

Injects targets into the active image set

Available inputs:

Name	Type	Values
`Motion_Type`	integer	`SPEED`=0, `PIXEL`=1
`Speed`	number	—
`PA`	number	—
`Pixels_X`	integer	—
`Pixels_Y`	integer	—
`Target_SNR`	number	—
`Target_FWHM`	number	—
`Unit_Pixels_FWHM`	boolean	—
`Num_Tgts_X`	integer	—
`Num_Tgts_Y`	integer	—
`Spacing_X`	integer	—
`Spacing_Y`	integer	—
`Pct_Offset_X`	number	—
`Pct_Offset_Y`	number	—
`Simulate_Streak`	boolean	—
`Override_Output_Dir`	boolean	—
`Path_Output_Dir`	string	—

shuffle

Signature: void shuffle(function callback)

Version: 1.0 Since: 13.0

Lua: host.images.shuffle()

Shuffles the active image set

Available inputs:

Name	Type	Values
`Override_Output_Dir`	boolean	—
`Path_Output_Dir`	string	—

merge

Signature: void merge(function callback)

Version: 1.0 Since: 13.0

Lua: host.images.merge()

Merges the active image set

Available inputs:

Name	Type	Values
`MaxDeltaTimeInSec`	number	—
`Override_Output_Dir`	boolean	—
`Path_Output_Dir`	string	—

get_dir_images

Signature: string get_dir_images()

Version: 1.0 Since: 13.0

Lua: host.images.get_dir_images()

Returns the full path to the directory containing the active image set

get_path_image

Signature: string get_path_image(int idx_img)

Version: 1.0 Since: 13.0

Lua: host.images.get_path_image()

Returns the full path to the image associated with the given zero-based index

attach_ephemeris

Signature: void attach_ephemeris(function callback)

Version: 1.0 Since: 13.0

Lua: host.images.attach_ephemeris()

Attaches ephemeris to the active image set based on the supplied observations file

Available inputs:

Name	Type	Values
`Path_Observations_File`	string	—

larson_sekanina

Signature: void larson_sekanina(function callback)

Version: 1.0 Since: 13.0

Lua: host.images.larson_sekanina()

Applies Larson-Sekanina filter to the active image set

Available inputs:

Name	Type	Values
`PluginName`	string	—
`PluginID`	integer	—
`val_ls_mode`	string	—
`val_radial_shift`	number	—
`val_rotational_shift`	number	—
`val_auto_center`	boolean	—
`val_pos_center_x`	integer	—
`val_pos_center_y`	integer	—

get_crosshair_x

Signature: int get_crosshair_x()

Version: 1.0 Since: 13.0

Lua: host.images.get_crosshair_x()

Return X coordinate of current crosshair location

get_crosshair_y

Signature: int get_crosshair_y()

Version: 1.0 Since: 13.0

Lua: host.images.get_crosshair_y()

Return Y coordinate of current crosshair location

reset_view

Signature: void reset_view()

Version: 1.0 Since: 13.0

Lua: host.images.reset_view()

Resets the current view in the Image Viewer

tracker

synthetic

Signature: void synthetic(function callback)

Version: 1.0 Since: 13.0

Lua: host.tracker.synthetic()

Operates the synthetic tracker on the active image set

Available inputs:

Name	Type	Values
`Sensitivity_Level`	integer	—
`MinImageShiftInPixels`	number	—
`AutoTimeoutInMinutes`	number	—
`MinMovementInPixels`	number	—
`MaxObjStreak`	number	—
`Force_Granularity`	boolean	—
`Granularity_Pct`	integer	—
`Enable_ClusterOperation`	boolean	—
`Enable_Multithreading`	boolean	—
`NumThreads`	integer	—
`Limit_Speed`	boolean	—
`Speed_Start`	number	—
`Speed_Stop`	number	—
`Limit_PA`	boolean	—
`PA_Start`	number	—
`PA_Stop`	number	—
`Crop_Sch`	boolean	—
`Crop_Amount`	integer	—

fast

Signature: void fast(function callback)

Version: 1.0 Since: 13.0

Lua: host.tracker.fast()

Operates the FAST tracker on the active image set

Available inputs:

Name	Type	Values
`Sensitivity_Mode`	integer	`REGULAR`=0, `MAXIMUM`=1
`Limit_Speed`	boolean	—
`Speed_Start`	number	—
`Speed_Stop`	number	—
`Limit_PA`	boolean	—
`PA_Start`	number	—
`PA_Stop`	number	—

get_num_tracks_synthetic

Signature: int get_num_tracks_synthetic(function callback)

Version: 1.0 Since: 13.0

Lua: host.tracker.get_num_tracks_synthetic()

Returns the number of tracks identified from the synthetic tracker

get_num_tracks_fast

Signature: int get_num_tracks_fast(function callback)

Version: 1.0 Since: 13.0

Lua: host.tracker.get_num_tracks_fast()

Returns the number of tracks identified from the FAST tracker

perform_step_verify

Signature: void perform_step_verify(function callback)

Version: 1.0 Since: 13.0

Lua: host.tracker.perform_step_verify()

Performs the verification step

perform_step_confidence

Signature: void perform_step_confidence(function callback)

Version: 1.0 Since: 13.0

Lua: host.tracker.perform_step_confidence()

Performs the confidence computation step

Available inputs:

Name	Type	Values
`Min_Track_Confidence`	integer	`UNKNOWN`=0, `NONE`=1, `LOW`=2, `MED`=3, `HIGH`=4
`Num_Tracks_To_Verify`	integer	—

perform_step_known_objects

Signature: void perform_step_known_objects(function callback)

Version: 1.0 Since: 13.0

Lua: host.tracker.perform_step_known_objects()

Loads known objects for the returned track list

Available inputs:

Name	Type	Values
`Match_Type_FAST`	integer	`ART_SATS`=0, `ASTEROIDS`=1

perform_step_create_obs

Signature: void perform_step_create_obs(function callback)

Version: 1.0 Since: 13.0

Lua: host.tracker.perform_step_create_obs()

Creates observations for each candidate track

Available inputs:

Name	Type	Values
`Create_Snapshots`	boolean	—
`Contrast_Level`	integer	`0` = default, `<0` less contrast, `>0` more contrast
`Intensity_Level`	integer	`0` = default, `<0` less intensity, `>0` more intensity

perform_step_save_tracks

Signature: void perform_step_save_tracks(function callback)

Version: 1.0 Since: 13.0

Lua: host.tracker.perform_step_save_tracks()

Saves the track list

perform_step_save_zero_motion

Signature: void perform_step_save_zero_motion(function callback)

Version: 1.0 Since: 13.0

Lua: host.tracker.perform_step_save_zero_motion()

Saves the zero motion stacked image

perform_step_finish

Signature: void perform_step_finish(function callback)

Version: 1.0 Since: 13.0

Lua: host.tracker.perform_step_finish()

Generates completion files for the output directory

kvp

load

Signature: PluginKVP load(string plugin_label_id)

Version: 1.0 Since: 13.0

Lua: host.kvp.load()

Returns a KVP handle for the specified plugin label ID

Tycho Lua Plugin Host API

Table of Contents

core

get_version

set_active_observatory_by_id

set_active_observatory_by_obs_code

set_active_observatory_by_label

add

subtract

sleep

log

msgbox

get_path_script

get_dir_script

exit

get_parent_dir

images

get_count

run_script_on_dir

load

save

cleanup

reset_file_list

add_output

calibrate

debayer

resize

plate_solve

align

drizzle

evaluate

inject_targets

shuffle

merge

get_dir_images

get_path_image

attach_ephemeris

larson_sekanina

get_crosshair_x

get_crosshair_y

reset_view

tracker

synthetic

fast

get_num_tracks_synthetic

get_num_tracks_fast

perform_step_verify

perform_step_confidence

perform_step_known_objects

perform_step_create_obs

perform_step_save_tracks

perform_step_save_zero_motion

perform_step_finish

kvp

load