diff --git a/.gitignore b/.gitignore index dfe0e8d..d2252c6 100644 --- a/.gitignore +++ b/.gitignore @@ -190,7 +190,7 @@ __pycache__/ .Python .venv/ env/ -bin/ +./bin/ build/ develop-eggs/ dist/ diff --git a/Cargo.toml b/Cargo.toml index 2242fd5..59c5bbc 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -11,6 +11,7 @@ exclude = [ "data/*", "images/*", ] +default-run = "starfinder" [dependencies] clap = { version = "4.5.16", features = ["derive"] } diff --git a/README.md b/README.md index 4944fd2..6758bfc 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,37 @@ ### Using Cargo (Rust) +The first step in using the renderer is to optimize your data. The optimizer can optimize against +_any_ star catalog as long as it fulfills the following requirements: + +1) Contains star data in CSV (any separator is usable) +2) Star data includes right ascension and declination for each record. Currently, they must be in degrees. +3) Star data includes vt_mag or bt_mag, preferably both + +Specify the column number of each of these four data points when calling the optimizer (bt and vt +mag are optional, but at least one is required). To optimize for the Tycho 2 catalog, run the +following command: +```bash +cargo run --bin optimize -- --idx-ra 24 --idx-dec 25 --idx-bt-mag 17 --idx-vt-mag 19 +``` +For other catalogs that satisfy the optimizer's requirements, simply replace the index values above +with the column indexes for those items in your catalog's data file. + +### Optimizer command-line arguments + +| Flag | Description | Default | Notes | +|--------------|------------------------------|---------------------------|------------------------------| +| --source, -s | Source file path | `data/tycho2/catalog.dat` | | +| --output, -o | Output filepath | `data/optimized.dat` | Recommend default | +| --separator | CSV file character separator | "|" | Tycho 2 data uses "|" | +| --idx-vt-mag | Index of vt_mag | | | +| --idx-bt-mag | Index of bt_mag | | | +| --idx-ra | Index of right ascension | | | +| --idx-dec | Index of declination | | | + + +### Running the renderer + To run the renderer with default settings: ```bash @@ -46,7 +77,7 @@ cargo run -- --roll 0.0 --fov-w 75.0 --fov-h 50.0 ### Command-line Arguments | Flag | Description | Default | Notes | -| --------------- | -------------------------------- | ------------------------- | ----------------- | +|-----------------|----------------------------------|---------------------------|-------------------| | --source, -s | Source file path | `data/tycho2/catalog.dat` | | | --center-ra | FOV center point right ascension | 180.0 | In degrees | | --center-dec | FOV center point declination | 0.0 | In degrees | diff --git a/bin/Activate.ps1 b/bin/Activate.ps1 new file mode 100644 index 0000000..b49d77b --- /dev/null +++ b/bin/Activate.ps1 @@ -0,0 +1,247 @@ +<# +.Synopsis +Activate a Python virtual environment for the current PowerShell session. + +.Description +Pushes the python executable for a virtual environment to the front of the +$Env:PATH environment variable and sets the prompt to signify that you are +in a Python virtual environment. Makes use of the command line switches as +well as the `pyvenv.cfg` file values present in the virtual environment. + +.Parameter VenvDir +Path to the directory that contains the virtual environment to activate. The +default value for this is the parent of the directory that the Activate.ps1 +script is located within. + +.Parameter Prompt +The prompt prefix to display when this virtual environment is activated. By +default, this prompt is the name of the virtual environment folder (VenvDir) +surrounded by parentheses and followed by a single space (ie. '(.venv) '). + +.Example +Activate.ps1 +Activates the Python virtual environment that contains the Activate.ps1 script. + +.Example +Activate.ps1 -Verbose +Activates the Python virtual environment that contains the Activate.ps1 script, +and shows extra information about the activation as it executes. + +.Example +Activate.ps1 -VenvDir C:\Users\MyUser\Common\.venv +Activates the Python virtual environment located in the specified location. + +.Example +Activate.ps1 -Prompt "MyPython" +Activates the Python virtual environment that contains the Activate.ps1 script, +and prefixes the current prompt with the specified string (surrounded in +parentheses) while the virtual environment is active. + +.Notes +On Windows, it may be required to enable this Activate.ps1 script by setting the +execution policy for the user. You can do this by issuing the following PowerShell +command: + +PS C:\> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser + +For more information on Execution Policies: +https://go.microsoft.com/fwlink/?LinkID=135170 + +#> +Param( + [Parameter(Mandatory = $false)] + [String] + $VenvDir, + [Parameter(Mandatory = $false)] + [String] + $Prompt +) + +<# Function declarations --------------------------------------------------- #> + +<# +.Synopsis +Remove all shell session elements added by the Activate script, including the +addition of the virtual environment's Python executable from the beginning of +the PATH variable. + +.Parameter NonDestructive +If present, do not remove this function from the global namespace for the +session. + +#> +function global:deactivate ([switch]$NonDestructive) { + # Revert to original values + + # The prior prompt: + if (Test-Path -Path Function:_OLD_VIRTUAL_PROMPT) { + Copy-Item -Path Function:_OLD_VIRTUAL_PROMPT -Destination Function:prompt + Remove-Item -Path Function:_OLD_VIRTUAL_PROMPT + } + + # The prior PYTHONHOME: + if (Test-Path -Path Env:_OLD_VIRTUAL_PYTHONHOME) { + Copy-Item -Path Env:_OLD_VIRTUAL_PYTHONHOME -Destination Env:PYTHONHOME + Remove-Item -Path Env:_OLD_VIRTUAL_PYTHONHOME + } + + # The prior PATH: + if (Test-Path -Path Env:_OLD_VIRTUAL_PATH) { + Copy-Item -Path Env:_OLD_VIRTUAL_PATH -Destination Env:PATH + Remove-Item -Path Env:_OLD_VIRTUAL_PATH + } + + # Just remove the VIRTUAL_ENV altogether: + if (Test-Path -Path Env:VIRTUAL_ENV) { + Remove-Item -Path env:VIRTUAL_ENV + } + + # Just remove VIRTUAL_ENV_PROMPT altogether. + if (Test-Path -Path Env:VIRTUAL_ENV_PROMPT) { + Remove-Item -Path env:VIRTUAL_ENV_PROMPT + } + + # Just remove the _PYTHON_VENV_PROMPT_PREFIX altogether: + if (Get-Variable -Name "_PYTHON_VENV_PROMPT_PREFIX" -ErrorAction SilentlyContinue) { + Remove-Variable -Name _PYTHON_VENV_PROMPT_PREFIX -Scope Global -Force + } + + # Leave deactivate function in the global namespace if requested: + if (-not $NonDestructive) { + Remove-Item -Path function:deactivate + } +} + +<# +.Description +Get-PyVenvConfig parses the values from the pyvenv.cfg file located in the +given folder, and returns them in a map. + +For each line in the pyvenv.cfg file, if that line can be parsed into exactly +two strings separated by `=` (with any amount of whitespace surrounding the =) +then it is considered a `key = value` line. The left hand string is the key, +the right hand is the value. + +If the value starts with a `'` or a `"` then the first and last character is +stripped from the value before being captured. + +.Parameter ConfigDir +Path to the directory that contains the `pyvenv.cfg` file. +#> +function Get-PyVenvConfig( + [String] + $ConfigDir +) { + Write-Verbose "Given ConfigDir=$ConfigDir, obtain values in pyvenv.cfg" + + # Ensure the file exists, and issue a warning if it doesn't (but still allow the function to continue). + $pyvenvConfigPath = Join-Path -Resolve -Path $ConfigDir -ChildPath 'pyvenv.cfg' -ErrorAction Continue + + # An empty map will be returned if no config file is found. + $pyvenvConfig = @{ } + + if ($pyvenvConfigPath) { + + Write-Verbose "File exists, parse `key = value` lines" + $pyvenvConfigContent = Get-Content -Path $pyvenvConfigPath + + $pyvenvConfigContent | ForEach-Object { + $keyval = $PSItem -split "\s*=\s*", 2 + if ($keyval[0] -and $keyval[1]) { + $val = $keyval[1] + + # Remove extraneous quotations around a string value. + if ("'""".Contains($val.Substring(0, 1))) { + $val = $val.Substring(1, $val.Length - 2) + } + + $pyvenvConfig[$keyval[0]] = $val + Write-Verbose "Adding Key: '$($keyval[0])'='$val'" + } + } + } + return $pyvenvConfig +} + + +<# Begin Activate script --------------------------------------------------- #> + +# Determine the containing directory of this script +$VenvExecPath = Split-Path -Parent $MyInvocation.MyCommand.Definition +$VenvExecDir = Get-Item -Path $VenvExecPath + +Write-Verbose "Activation script is located in path: '$VenvExecPath'" +Write-Verbose "VenvExecDir Fullname: '$($VenvExecDir.FullName)" +Write-Verbose "VenvExecDir Name: '$($VenvExecDir.Name)" + +# Set values required in priority: CmdLine, ConfigFile, Default +# First, get the location of the virtual environment, it might not be +# VenvExecDir if specified on the command line. +if ($VenvDir) { + Write-Verbose "VenvDir given as parameter, using '$VenvDir' to determine values" +} +else { + Write-Verbose "VenvDir not given as a parameter, using parent directory name as VenvDir." + $VenvDir = $VenvExecDir.Parent.FullName.TrimEnd("\\/") + Write-Verbose "VenvDir=$VenvDir" +} + +# Next, read the `pyvenv.cfg` file to determine any required value such +# as `prompt`. +$pyvenvCfg = Get-PyVenvConfig -ConfigDir $VenvDir + +# Next, set the prompt from the command line, or the config file, or +# just use the name of the virtual environment folder. +if ($Prompt) { + Write-Verbose "Prompt specified as argument, using '$Prompt'" +} +else { + Write-Verbose "Prompt not specified as argument to script, checking pyvenv.cfg value" + if ($pyvenvCfg -and $pyvenvCfg['prompt']) { + Write-Verbose " Setting based on value in pyvenv.cfg='$($pyvenvCfg['prompt'])'" + $Prompt = $pyvenvCfg['prompt']; + } + else { + Write-Verbose " Setting prompt based on parent's directory's name. (Is the directory name passed to venv module when creating the virtual environment)" + Write-Verbose " Got leaf-name of $VenvDir='$(Split-Path -Path $venvDir -Leaf)'" + $Prompt = Split-Path -Path $venvDir -Leaf + } +} + +Write-Verbose "Prompt = '$Prompt'" +Write-Verbose "VenvDir='$VenvDir'" + +# Deactivate any currently active virtual environment, but leave the +# deactivate function in place. +deactivate -nondestructive + +# Now set the environment variable VIRTUAL_ENV, used by many tools to determine +# that there is an activated venv. +$env:VIRTUAL_ENV = $VenvDir + +if (-not $Env:VIRTUAL_ENV_DISABLE_PROMPT) { + + Write-Verbose "Setting prompt to '$Prompt'" + + # Set the prompt to include the env name + # Make sure _OLD_VIRTUAL_PROMPT is global + function global:_OLD_VIRTUAL_PROMPT { "" } + Copy-Item -Path function:prompt -Destination function:_OLD_VIRTUAL_PROMPT + New-Variable -Name _PYTHON_VENV_PROMPT_PREFIX -Description "Python virtual environment prompt prefix" -Scope Global -Option ReadOnly -Visibility Public -Value $Prompt + + function global:prompt { + Write-Host -NoNewline -ForegroundColor Green "($_PYTHON_VENV_PROMPT_PREFIX) " + _OLD_VIRTUAL_PROMPT + } + $env:VIRTUAL_ENV_PROMPT = $Prompt +} + +# Clear PYTHONHOME +if (Test-Path -Path Env:PYTHONHOME) { + Copy-Item -Path Env:PYTHONHOME -Destination Env:_OLD_VIRTUAL_PYTHONHOME + Remove-Item -Path Env:PYTHONHOME +} + +# Add the venv to the PATH +Copy-Item -Path Env:PATH -Destination Env:_OLD_VIRTUAL_PATH +$Env:PATH = "$VenvExecDir$([System.IO.Path]::PathSeparator)$Env:PATH" diff --git a/bin/activate b/bin/activate new file mode 100644 index 0000000..8d47be8 --- /dev/null +++ b/bin/activate @@ -0,0 +1,70 @@ +# This file must be used with "source bin/activate" *from bash* +# You cannot run it directly + +deactivate () { + # reset old environment variables + if [ -n "${_OLD_VIRTUAL_PATH:-}" ] ; then + PATH="${_OLD_VIRTUAL_PATH:-}" + export PATH + unset _OLD_VIRTUAL_PATH + fi + if [ -n "${_OLD_VIRTUAL_PYTHONHOME:-}" ] ; then + PYTHONHOME="${_OLD_VIRTUAL_PYTHONHOME:-}" + export PYTHONHOME + unset _OLD_VIRTUAL_PYTHONHOME + fi + + # Call hash to forget past commands. Without forgetting + # past commands the $PATH changes we made may not be respected + hash -r 2> /dev/null + + if [ -n "${_OLD_VIRTUAL_PS1:-}" ] ; then + PS1="${_OLD_VIRTUAL_PS1:-}" + export PS1 + unset _OLD_VIRTUAL_PS1 + fi + + unset VIRTUAL_ENV + unset VIRTUAL_ENV_PROMPT + if [ ! "${1:-}" = "nondestructive" ] ; then + # Self destruct! + unset -f deactivate + fi +} + +# unset irrelevant variables +deactivate nondestructive + +# on Windows, a path can contain colons and backslashes and has to be converted: +if [ "${OSTYPE:-}" = "cygwin" ] || [ "${OSTYPE:-}" = "msys" ] ; then + # transform D:\path\to\venv to /d/path/to/venv on MSYS + # and to /cygdrive/d/path/to/venv on Cygwin + export VIRTUAL_ENV=$(cygpath "/home/layton-miller/dev/nasa-workgroup/starfinder") +else + # use the path as-is + export VIRTUAL_ENV="/home/layton-miller/dev/nasa-workgroup/starfinder" +fi + +_OLD_VIRTUAL_PATH="$PATH" +PATH="$VIRTUAL_ENV/bin:$PATH" +export PATH + +# unset PYTHONHOME if set +# this will fail if PYTHONHOME is set to the empty string (which is bad anyway) +# could use `if (set -u; : $PYTHONHOME) ;` in bash +if [ -n "${PYTHONHOME:-}" ] ; then + _OLD_VIRTUAL_PYTHONHOME="${PYTHONHOME:-}" + unset PYTHONHOME +fi + +if [ -z "${VIRTUAL_ENV_DISABLE_PROMPT:-}" ] ; then + _OLD_VIRTUAL_PS1="${PS1:-}" + PS1="(starfinder) ${PS1:-}" + export PS1 + VIRTUAL_ENV_PROMPT="(starfinder) " + export VIRTUAL_ENV_PROMPT +fi + +# Call hash to forget past commands. Without forgetting +# past commands the $PATH changes we made may not be respected +hash -r 2> /dev/null diff --git a/bin/activate.csh b/bin/activate.csh new file mode 100644 index 0000000..f51f83c --- /dev/null +++ b/bin/activate.csh @@ -0,0 +1,27 @@ +# This file must be used with "source bin/activate.csh" *from csh*. +# You cannot run it directly. + +# Created by Davide Di Blasi . +# Ported to Python 3.3 venv by Andrew Svetlov + +alias deactivate 'test $?_OLD_VIRTUAL_PATH != 0 && setenv PATH "$_OLD_VIRTUAL_PATH" && unset _OLD_VIRTUAL_PATH; rehash; test $?_OLD_VIRTUAL_PROMPT != 0 && set prompt="$_OLD_VIRTUAL_PROMPT" && unset _OLD_VIRTUAL_PROMPT; unsetenv VIRTUAL_ENV; unsetenv VIRTUAL_ENV_PROMPT; test "\!:*" != "nondestructive" && unalias deactivate' + +# Unset irrelevant variables. +deactivate nondestructive + +setenv VIRTUAL_ENV "/home/layton-miller/dev/nasa-workgroup/starfinder" + +set _OLD_VIRTUAL_PATH="$PATH" +setenv PATH "$VIRTUAL_ENV/bin:$PATH" + + +set _OLD_VIRTUAL_PROMPT="$prompt" + +if (! "$?VIRTUAL_ENV_DISABLE_PROMPT") then + set prompt = "(starfinder) $prompt" + setenv VIRTUAL_ENV_PROMPT "(starfinder) " +endif + +alias pydoc python -m pydoc + +rehash diff --git a/bin/activate.fish b/bin/activate.fish new file mode 100644 index 0000000..5146d18 --- /dev/null +++ b/bin/activate.fish @@ -0,0 +1,69 @@ +# This file must be used with "source /bin/activate.fish" *from fish* +# (https://fishshell.com/). You cannot run it directly. + +function deactivate -d "Exit virtual environment and return to normal shell environment" + # reset old environment variables + if test -n "$_OLD_VIRTUAL_PATH" + set -gx PATH $_OLD_VIRTUAL_PATH + set -e _OLD_VIRTUAL_PATH + end + if test -n "$_OLD_VIRTUAL_PYTHONHOME" + set -gx PYTHONHOME $_OLD_VIRTUAL_PYTHONHOME + set -e _OLD_VIRTUAL_PYTHONHOME + end + + if test -n "$_OLD_FISH_PROMPT_OVERRIDE" + set -e _OLD_FISH_PROMPT_OVERRIDE + # prevents error when using nested fish instances (Issue #93858) + if functions -q _old_fish_prompt + functions -e fish_prompt + functions -c _old_fish_prompt fish_prompt + functions -e _old_fish_prompt + end + end + + set -e VIRTUAL_ENV + set -e VIRTUAL_ENV_PROMPT + if test "$argv[1]" != "nondestructive" + # Self-destruct! + functions -e deactivate + end +end + +# Unset irrelevant variables. +deactivate nondestructive + +set -gx VIRTUAL_ENV "/home/layton-miller/dev/nasa-workgroup/starfinder" + +set -gx _OLD_VIRTUAL_PATH $PATH +set -gx PATH "$VIRTUAL_ENV/bin" $PATH + +# Unset PYTHONHOME if set. +if set -q PYTHONHOME + set -gx _OLD_VIRTUAL_PYTHONHOME $PYTHONHOME + set -e PYTHONHOME +end + +if test -z "$VIRTUAL_ENV_DISABLE_PROMPT" + # fish uses a function instead of an env var to generate the prompt. + + # Save the current fish_prompt function as the function _old_fish_prompt. + functions -c fish_prompt _old_fish_prompt + + # With the original prompt function renamed, we can override with our own. + function fish_prompt + # Save the return status of the last command. + set -l old_status $status + + # Output the venv prompt; color taken from the blue of the Python logo. + printf "%s%s%s" (set_color 4B8BBE) "(starfinder) " (set_color normal) + + # Restore the return status of the previous command. + echo "exit $old_status" | . + # Output the original/"old" prompt. + _old_fish_prompt + end + + set -gx _OLD_FISH_PROMPT_OVERRIDE "$VIRTUAL_ENV" + set -gx VIRTUAL_ENV_PROMPT "(starfinder) " +end diff --git a/bin/pip b/bin/pip new file mode 100755 index 0000000..001511e --- /dev/null +++ b/bin/pip @@ -0,0 +1,8 @@ +#!/home/layton-miller/dev/nasa-workgroup/starfinder/bin/python3 +# -*- coding: utf-8 -*- +import re +import sys +from pip._internal.cli.main import main +if __name__ == '__main__': + sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0]) + sys.exit(main()) diff --git a/bin/pip3 b/bin/pip3 new file mode 100755 index 0000000..001511e --- /dev/null +++ b/bin/pip3 @@ -0,0 +1,8 @@ +#!/home/layton-miller/dev/nasa-workgroup/starfinder/bin/python3 +# -*- coding: utf-8 -*- +import re +import sys +from pip._internal.cli.main import main +if __name__ == '__main__': + sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0]) + sys.exit(main()) diff --git a/bin/pip3.12 b/bin/pip3.12 new file mode 100755 index 0000000..001511e --- /dev/null +++ b/bin/pip3.12 @@ -0,0 +1,8 @@ +#!/home/layton-miller/dev/nasa-workgroup/starfinder/bin/python3 +# -*- coding: utf-8 -*- +import re +import sys +from pip._internal.cli.main import main +if __name__ == '__main__': + sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0]) + sys.exit(main()) diff --git a/bin/python b/bin/python new file mode 120000 index 0000000..b8a0adb --- /dev/null +++ b/bin/python @@ -0,0 +1 @@ +python3 \ No newline at end of file diff --git a/bin/python3 b/bin/python3 new file mode 120000 index 0000000..ae65fda --- /dev/null +++ b/bin/python3 @@ -0,0 +1 @@ +/usr/bin/python3 \ No newline at end of file diff --git a/bin/python3.12 b/bin/python3.12 new file mode 120000 index 0000000..b8a0adb --- /dev/null +++ b/bin/python3.12 @@ -0,0 +1 @@ +python3 \ No newline at end of file diff --git a/example.py b/example.py index bcac064..8c417b5 100644 --- a/example.py +++ b/example.py @@ -1,8 +1,8 @@ from starfinder import StarCatalogArgs, process_star_catalog_py -# Create arguments for star catalog processing +# Create arguments for star catalog processing. Remember the data needs to be optimized before use args = StarCatalogArgs( - file="data/tycho2/catalog.dat", + file="data/optimized.dat", display_count=10, min_ra=0.0, max_ra=360.0, diff --git a/src/bin/optimize.rs b/src/bin/optimize.rs new file mode 100644 index 0000000..12da07a --- /dev/null +++ b/src/bin/optimize.rs @@ -0,0 +1,101 @@ +use clap::Parser; +use csv::ReaderBuilder; +use starfinder::parsing_utils::parse_star_record; +use std::fs::File; +use std::io::{BufReader, BufWriter, Write}; +use std::time::Instant; + +const CSV_SEPARATOR: char = '|'; + +/// CLI Arguments +#[derive(Parser, Debug)] +#[command(author, version, about, long_about = None)] +pub struct Args { + /// Default to attempting to ingest and optimize the tycho2 data set per library standard + #[arg(short, long, default_value = "data/tycho2/catalog.dat")] + source: String, + + /// Output to standard pre-parsed file location - deviating from this means changing source when + /// calling the renderer + #[arg(short, long, default_value = "data/optimized.dat")] + output: String, + + #[arg(long, default_value = "|")] + separator: String, + + #[arg(long)] + idx_vt_mag: Option, + + #[arg(long)] + idx_bt_mag: Option, + + #[arg(long)] + idx_ra: usize, + + #[arg(long)] + idx_dec: usize, +} + +fn main() -> Result<(), Box> { + let run_start = Instant::now(); + let args = Args::parse(); + + if args.idx_bt_mag.is_none() && args.idx_vt_mag.is_none() { + panic!("Must specify at least one of idx-bt-mag or idx-vt-mag (ideally both)."); + } + if args.separator.len() > 1 { + panic!("Separator must be a single character."); + } + + println!("Reading catalog data and optimizing to starfinder format. This may take a while..."); + let src_file = File::open(args.source)?; + let src_reader = BufReader::new(src_file); + let mut csv_reader = ReaderBuilder::new() + .delimiter(args.separator.to_string().into_bytes()[0]) + .has_headers(false) + .from_reader(src_reader); + + let out_file = File::create(args.output)?; + let mut out_buffer = BufWriter::new(out_file); + + for (i, result) in csv_reader.records().enumerate() { + let record = result?; + + let mut skipped_rows = 0; + + match parse_star_record( + &record, + Some(args.idx_ra), + Some(args.idx_dec), + args.idx_bt_mag, + args.idx_vt_mag, + ) { + Ok(star) => { + let grid_coords = star.coords.to_grid(); + let ra = star.coords.ra; + let dec = star.coords.dec; + let grid_ra = grid_coords.ra; + let grid_dec = grid_coords.dec; + let mag = star.mag; + let s = CSV_SEPARATOR; + + out_buffer.write_all( + format!("{ra}{s}{dec}{s}{grid_ra}{s}{grid_dec}{s}{mag}\n").as_bytes() + )?; + } + Err(e) => { + skipped_rows += 1; + if skipped_rows <= 10 { + println!("Skipping row {} due to error: {:?}", i, e); + println!("Problematic row: {:?}", record); + } else if skipped_rows == 11 { + println!("Further skipped rows will not be printed..."); + } + } + } + } + out_buffer.flush()?; + + println!("Total run time elapsed: {:?}", run_start.elapsed()); + Ok(()) +} diff --git a/src/fov.rs b/src/fov.rs index 748e070..6adaa40 100644 --- a/src/fov.rs +++ b/src/fov.rs @@ -4,6 +4,8 @@ use std::f64::consts::PI; use crate::types::{CartesianCoords, EquatorialCoords}; +// CAREFUL! If this value is ever changed, the optimize binary needs to be rerun!! The data is +// optimized against this grid resolution. pub const GRID_RESOLUTION: f64 = 360.0; pub fn get_fov( diff --git a/src/main.rs b/src/main.rs index 5c0eac8..0ef7870 100644 --- a/src/main.rs +++ b/src/main.rs @@ -7,14 +7,9 @@ use starfinder::types::StarCatalogArgs; #[derive(Parser, Debug)] #[command(author, version, about, long_about = None)] pub struct Args { - /// Path to the Tycho-2 catalog file - #[arg( - short, - long, - value_name = "FILE", - default_value = "data/tycho2/catalog.dat" - )] - source: String, + /// Path to the optimized catalog file. The optimize binary should be run before running this to + /// generate the optimized data file. + #[arg(short, long, default_value = "data/optimized.dat")]source: String, /// Right Ascension of camera view center point (degrees) #[arg(long, default_value_t = 180.0)] diff --git a/src/parsing_utils.rs b/src/parsing_utils.rs index c41231b..128233f 100644 --- a/src/parsing_utils.rs +++ b/src/parsing_utils.rs @@ -21,7 +21,7 @@ pub enum CatalogError { MissingMagnitude, } -/// Reads and filters stars from the Tycho-2 catalog file. +/// Reads and filters stars from the optimized data file. /// https://heasarc.gsfc.nasa.gov/w3browse/all/tycho2.html /// http://tdc-www.harvard.edu/catalogs/tycho2.format.html /// All values should be in radians. While star coords in the catalog are in degrees, the coordinate @@ -43,9 +43,12 @@ pub fn read_stars>( for (i, result) in csv_reader.records().enumerate() { let record = result?; - match parse_star_record(&record) { - Ok(star) => { - let grid_coords = &star.coords.to_grid(); + // Use the indexes for the optimized data file! + match parse_optimized_star_record(&record) { + Ok(data) => { + let star = data.0; + let grid_coords = data.1; + if star.mag < max_magnitude && filter_grid.contains(&grid_coords) { stars.push(star); } @@ -68,11 +71,37 @@ pub fn read_stars>( Ok(stars) } +/// Parses the *optimize* star data file and pulls out the star as well as its pre-computed ra/dec +/// in the localization grid format as a separate EquatorialCoordinate +pub fn parse_optimized_star_record(record: &csv::StringRecord) -> Result<(Star, EquatorialCoords), CatalogError> { + Ok(( + Star { + coords: EquatorialCoords { + ra: parse_field(record, 0, "RA")?, + dec: parse_field(record, 1, "Dec")?, + }, + mag: parse_field(record, 4, "Magnitude")?, + }, + EquatorialCoords { + ra: parse_field(record, 2, "GridRA")?, + dec: parse_field(record, 3, "GridDec")?, + } + )) +} + /// Parses a single record from the catalog into a Star struct. -pub fn parse_star_record(record: &csv::StringRecord) -> Result { - let ra = parse_field(record, 24, "RA")?; - let dec = parse_field(record, 25, "Dec")?; - let mag = parse_magnitude(record)?; +/// Defaults for the index positions of data fields are set to Tycho 2 catalog format. This can be +/// specified differently if a different star catalog is to be used +pub fn parse_star_record( + record: &csv::StringRecord, + idx_ra: Option, + idx_dec: Option, + idx_bt_mag: Option, + idx_vt_mag: Option, +) -> Result { + let ra = parse_field(record, idx_ra.unwrap_or(24), "RA")?; + let dec = parse_field(record, idx_dec.unwrap_or(25), "Dec")?; + let mag = parse_magnitude(record, idx_bt_mag, idx_vt_mag)?; Ok(Star { coords: EquatorialCoords { @@ -84,9 +113,15 @@ pub fn parse_star_record(record: &csv::StringRecord) -> Result Result { - let bt_mag = parse_field(record, 17, "BT magnitude").ok(); - let vt_mag = parse_field(record, 19, "VT magnitude").ok(); +/// Defaults for the index positions of data fields are set to Tycho 2 catalog format. This can be +/// specified differently if a different star catalog is to be used +pub fn parse_magnitude( + record: &csv::StringRecord, + idx_bt_mag: Option, + idx_vt_mag: Option, +) -> Result { + let bt_mag = parse_field(record, idx_bt_mag.unwrap_or(17), "BT magnitude").ok(); + let vt_mag = parse_field(record, idx_vt_mag.unwrap_or(19), "VT magnitude").ok(); // println!("Debug: BT_Mag = {:?}, VT_Mag = {:?}", bt_mag, vt_mag);