Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
GermanHydrogen committed Aug 9, 2024
1 parent 156a821 commit 06721ac
Showing 1 changed file with 31 additions and 5 deletions.
36 changes: 31 additions & 5 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,39 @@ This pipeline estimates the limiting magnitude of each pixel based on the visibi

## Web Service

Route: `/query?ra={Right ascension in degree}&dec={Declination in degree}`
### Point Query
Returns the cloudiness value of the analyzed sky position closest to the requested position. <br>
**Route**: <br>
`/query/point?ra={Right ascension in degree}&dec={Declination in degree}` or <br>
`/query/point?alt={Altitude in degree}&dec={Altitude in degree}`

### Result
| Field | Type | Description |
|----------|-------|-------------------------------------------------|
**Example:** <br>
`/query/point?alt=90.0&dec=0.0`


**Result:**

| Field | Type | Description |
|----------|-------|--------------------------------------------------|
| obs_time | float | Observation Unix time of the last analyzed image |
| value | bool | If it is cloudy at the requested point |

### Area Query
Returns the cloud fraction within the requested great circle.

**Route**: <br>
`/query/area?ra={Right ascension in degree}&dec={Declination in degree}&radius={Radius of the great circle in degree}` or <br>
`/query/area?alt={Altitude in degree}&dec={Altitude in degree}&radius={Radius of the great circle in degree}`

**Example:** <br>
`/query/area?alt=90.0&dec=0.0&radius=10.0`

**Result:**

| Field | Type | Description |
|----------|-------|--------------------------------------------------|
| obs_time | float | Observation Unix time of the last analyzed image |
| value | float | Limiting magnitude in mag |
| value | float | Cloud fraction in the requested area |


## Configuration
Expand Down

0 comments on commit 06721ac

Please sign in to comment.