Struct SolveRequest 

pub struct SolveRequest {

    pub hint: Option<(f64, f64)>,
    pub fov_height: Option<f64>,
    pub pixel_scale: Option<f64>,
    pub search_radius: f64,
    pub downsample: Option<usize>,
    pub db_path: Option<PathBuf>,
    pub db_name: Option<String>,
    pub index: Option<PathBuf>,
    pub index_first: bool,
    pub auto_index: bool,
    pub hfd_min_arcsec: f64,
    pub quad_tolerance: f64,
    pub max_stars: usize,
    pub method: SolveMethod,
    pub speed: SearchSpeed,
    pub threads: usize,
    pub sip: bool,
    pub cancel: Option<CancelToken>,
}

What the caller knows about an image and how it wants it solved, in the caller’s terms. Every field has the CLI’s default (SolveRequest::default).

Fields

hint: Option<(f64, f64)>

Approximate centre (RA, Dec), radians. None for no hint: the search starts at (0, 0), and an installed blind index is used as for any wide search.

fov_height: Option<f64>

Field of view along the image height, radians (ASTAP’s -fov). Takes precedence over Self::pixel_scale.

pixel_scale: Option<f64>

Pixel scale of the unbinned image, arcseconds per pixel (for instance from the FOCALLEN and XPIXSZ header keywords). Without it or a field of view, 1″/px is assumed.

search_radius: f64

Search radius around the hint, radians. Negative or NaN means 0.

downsample: Option<usize>

Binning factor; None or Some(0) chooses one (choose_binning).

db_path: Option<PathBuf>

Star database directory; None for default_db_path.

db_name: Option<String>

Star database name ("d50"); None to choose by field size (select_db_for_fov).

index: Option<PathBuf>

Blind index to use (the CLI’s --index): an arcsec .arcsecix file, a directory holding one, or Astrometry.net index-*.fits files. None still uses an arcsec index installed in the catalogue directory for a wide search, unless Self::auto_index is off.

index_first: bool

With a hint, whether the index named in Self::index is tried before the search round the hint (the CLI’s --index: true, the default), or only after the spiral has searched a few fields round it (false), as an installed index is. Without a hint the index always comes first.

auto_index: bool

Consult an arcsec index installed in the catalogue directory (or beside the star database) when the search is wider than a few fields and at least 10°. On by default, as in the CLI.

hfd_min_arcsec: f64

Minimum star size (HFD), arcseconds.

quad_tolerance: f64

Pattern-matching tolerance.

max_stars: usize

Maximum number of image stars to use.

method: SolveMethod

Pattern-matching algorithm.

speed: SearchSpeed

Catalogue window per spiral position.

threads: usize

Worker threads for this solve; 0 for the process-wide limit (crate::max_threads).

sip: bool

Fit SIP distortion polynomials to the solution (crate::wcs::fit_sip).

cancel: Option<CancelToken>

Stop early when this token is cancelled (ArcsecError::Cancelled).

Trait Implementations

impl Clone for SolveRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SolveRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SolveRequest

fn default() -> Self

The CLI’s defaults: no hint, a 180° radius (the whole sky), 500 stars, tolerance 0.007, minimum HFD 1.5″, automatic binning and database.