Skip to content

Start work on documentation #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
vladtcvs wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Start work on documentation #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ This mode should be used when perspective distorsions are valueable.
### Projections

* perspective projection - use perspective projection with specified focal length and pixel size
* equirectangular projection - used for planet surface map
* orhtographic projection - used for process planet surface images

## Flat mode

Expand All @@ -27,8 +29,9 @@ In this mode we don't know anything about celestial sphere and consider images a
# Modes of image aligning

* stars mode - images contains stars and should be aligned by stars
* compact_objects - images contains some small object, much less than image size, and this object
* objects mode - images contains some small object, much less than image size, and this object
should be cutted out and images should be aligned to center object
* disc mode - used for Moon, and other big disc objects

## Stars mode

Expand All @@ -38,12 +41,6 @@ Command for work with stars beginning with `vstarstack stars`.

`vstarstack stars detect` - detect stars on image

### lonlat

`vstarstack stars lonlat`

If we use `sphere` mode, we transform `(y,x)` coordinates of detected stars into `(lat,lon)` coordinates, with `(0,0)` at center of image.

### describe

`vstarstack stars describe`
Expand All @@ -54,23 +51,29 @@ We build descriptors for N most brightest stars. Each descriptor is invariant to

`vstarstack stars match`

We match the same stars on different images using descriptors
We match the same stars on different images using descriptors abd build match table

## Objects

### net
This commands work with non-star objects - planets, diffraction images, Moon, etc

`vstarstack stars net`
`vstarstack objects config`
`vstarstack objects detect`
`vstarstack objects cut`
`vstarstack objects clusters`

Build `net.json` - file with info about star matching. This is intermidiate format.
## Planets

### cluster
`vstarstack planets configure`
`vstarstack planets buildmap`

`vstarstack stars cluster`
## Clusters

Build `clusters.json` - file with clusters of stars. It contains info about stars coordinates on each frame.
`vstarstack cluster`

### process
# CI

`vstarstack stars process` - do all steps above in a single run
Jenkins used for CI

# License

Expand Down