Title: | Interface to the Pan-STARRS API |
---|---|
Description: | An interface to the API for 'Pan-STARRS1', a data archive of the PS1 wide-field astronomical survey. The package allows access to the PS1 catalog and to the PS1 images. (see <https://outerspace.stsci.edu/display/PANSTARRS/> for more information). You can use it to plan astronomical observations, make guidance pictures, find magnitudes in five broadband filters (g, r, i, z, y) and more. |
Authors: | Grigory Uskov [cre, aut] |
Maintainer: | Grigory Uskov <[email protected]> |
License: | MIT + file LICENSE |
Version: | 0.2.2 |
Built: | 2024-11-08 04:58:35 UTC |
Source: | https://github.com/uskovgs/panstarrs |
Do a cone search of the PS1 catalog
ps1_cone( ra, dec, r_arcmin = 0.05, table = c("mean", "stack", "detection", "forced_mean"), release = c("dr2", "dr1"), columns = NULL, verbose = FALSE, ... )
ps1_cone( ra, dec, r_arcmin = 0.05, table = c("mean", "stack", "detection", "forced_mean"), release = c("dr2", "dr1"), columns = NULL, verbose = FALSE, ... )
ra |
(degrees) J2000 Right Ascension |
dec |
(degrees) J2000 Declination |
r_arcmin |
(arcmins) Search radius (<= 30 arcmins) |
table |
"mean"(default), "stack", "detection" or "forced_mean" |
release |
"dr1" or "dr2"(default) |
columns |
list of column names to include (NULL means use defaults) |
verbose |
print info about request |
... |
other parameters (e.g., nDetections.min = 2) |
data.frame
## Not run: ps1_cone(ra = 139.334,dec = 68.635,r_arcmin = 0.05, nDetections.gt = 1) ## End(Not run)
## Not run: ps1_cone(ra = 139.334,dec = 68.635,r_arcmin = 0.05, nDetections.gt = 1) ## End(Not run)
Do a cross-match with PS1 catalog
ps1_crossmatch( ra, dec, r_arcmin = 0.05, table = c("mean", "stack", "detection", "forced_mean"), release = c("dr2", "dr1"), verbose = FALSE )
ps1_crossmatch( ra, dec, r_arcmin = 0.05, table = c("mean", "stack", "detection", "forced_mean"), release = c("dr2", "dr1"), verbose = FALSE )
ra |
(degrees) numeric vector of J2000 Right Ascension |
dec |
(degrees) numeric vector of J2000 Declination |
r_arcmin |
(arcmins) Search radius (<= 30 arcmins) |
table |
"mean"(default), "stack", "detection", "forced_mean" |
release |
"dr1" or "dr2"(default) |
verbose |
print info about request |
data.frame
## Not run: ps1_crossmatch(ra = c(268.70342, 168.87258), dec = c(71.54292, 60.75153)) ## End(Not run)
## Not run: ps1_crossmatch(ra = c(268.70342, 168.87258), dec = c(71.54292, 60.75153)) ## End(Not run)
Get color image at a sky position
ps1_image_color( ra, dec, size = 240, output_size = NULL, filters = "grizy", format = "jpg" )
ps1_image_color( ra, dec, size = 240, output_size = NULL, filters = "grizy", format = "jpg" )
ra |
ra position in degrees |
dec |
dec position in degrees |
size |
extracted image size in pixels (0.25 arcsec/pixel) |
output_size |
output (display) image size in pixels (default = size). output_size has no effect for fits format images. |
filters |
string with filters to include |
format |
data format (options are "jpg", "png") |
the image url
## Not run: ps1_image_color(ra = 83.633210, dec = 22.014460, size = 1280, filters="grz") ## End(Not run)
## Not run: ps1_image_color(ra = 83.633210, dec = 22.014460, size = 1280, filters="grz") ## End(Not run)
Get grayscale image at a sky position
ps1_image_gray( ra, dec, size = 240, output_size = NULL, filter = "g", format = "jpg" )
ps1_image_gray( ra, dec, size = 240, output_size = NULL, filter = "g", format = "jpg" )
ra |
ra position in degrees |
dec |
dec position in degrees |
size |
extracted image size in pixels (0.25 arcsec/pixel) |
output_size |
output (display) image size in pixels (default = size). output_size has no effect for fits format images. |
filter |
string with filter to extract (one of grizy) |
format |
data format (options are "jpg", "png") |
the image
## Not run: ps1_image_gray(ra = 83.633210, dec = 22.014460, size = 1280, filter = "i") ## End(Not run)
## Not run: ps1_image_gray(ra = 83.633210, dec = 22.014460, size = 1280, filter = "i") ## End(Not run)
Query ps1filenames.py service to get a list of images.
ps1_image_list(ra, dec, size = 240, filters = "grizy")
ps1_image_list(ra, dec, size = 240, filters = "grizy")
ra |
ra position in degrees |
dec |
dec position in degrees |
size |
image size in pixels (0.25 arcsec/pixel) |
filters |
string with filters to include |
src: https://ps1images.stsci.edu/ps1image.html
table with the results
## Not run: # Crab nebulae image ps1_image_list(ra = 83.633210, dec = 22.014460, size = 1280, filters = "grz") ## End(Not run)
## Not run: # Crab nebulae image ps1_image_list(ra = 83.633210, dec = 22.014460, size = 1280, filters = "grz") ## End(Not run)
Get URL of images
ps1_image_url( ra, dec, size = 240, output_size = NULL, filters = "grizy", format = "jpg", color = FALSE )
ps1_image_url( ra, dec, size = 240, output_size = NULL, filters = "grizy", format = "jpg", color = FALSE )
ra |
ra position in degrees |
dec |
dec position in degrees |
size |
extracted image size in pixels (0.25 arcsec/pixel) |
output_size |
output (display) image size in pixels (default = size). output_size has no effect for fits format images. |
filters |
string with filters to include |
format |
data format (options are "jpg", "png" or "fits") |
color |
if TRUE, creates a color image (only for jpg or png format). Default is return a list of URLs for single-filter grayscale images. |
string with the URL
## Not run: ps1_image_url( ra = 83.633210, dec = 22.014460, size = 1280, format = "jpg", filters = "grz", color = T) ## End(Not run)
## Not run: ps1_image_url( ra = 83.633210, dec = 22.014460, size = 1280, format = "jpg", filters = "grz", color = T) ## End(Not run)
Get the RA and Dec for an object using the MAST name resolver
ps1_mast_resolve(name)
ps1_mast_resolve(name)
name |
Name of object |
list of ra, decl
## Not run: ps1_mast_resolve('Acrux') ## End(Not run)
## Not run: ps1_mast_resolve('Acrux') ## End(Not run)
Return metadata for the specified catalog and table
ps1_metadata(table = "mean", release = "dr2")
ps1_metadata(table = "mean", release = "dr2")
table |
"mean", "stack", "forced_mean" or "detection" |
release |
"dr1" or "dr2"(default) |
Returns data.frame with columns: name, type, description
## Not run: ps1_metadata() ## End(Not run)
## Not run: ps1_metadata() ## End(Not run)
Only works for "north" objects with decl > -30. For all objects see function 'ps1_mast_resolve'.
ps1_resolve(target_names, verbose = FALSE)
ps1_resolve(target_names, verbose = FALSE)
target_names |
character vector of target names (see example) |
verbose |
print info about request |
data.frame
## Not run: ps1_resolve(c('Andromeda', "SN 2005D", 'Antennae', 'ANTENNAE')) ## End(Not run)
## Not run: ps1_resolve(c('Andromeda', "SN 2005D", 'Antennae', 'ANTENNAE')) ## End(Not run)
Do a general search of the PS1 catalog (possibly without ra/dec/radius)
ps1_search( table = c("mean", "stack", "detection", "forced_mean"), release = c("dr2", "dr1"), columns = NULL, verbose = FALSE, ... )
ps1_search( table = c("mean", "stack", "detection", "forced_mean"), release = c("dr2", "dr1"), columns = NULL, verbose = FALSE, ... )
table |
"mean", "stack", "detection" or "forced_mean" |
release |
"dr1" or "dr2"(default) |
columns |
list of column names to include (NULL means use defaults) |
verbose |
print info about request |
... |
other parameters (e.g., nDetections.min = 2). |
data.frame
## Not run: ps1_search( table='detection', release='dr2', objid = '190361393344112894') ps1_search( table='mean', release='dr2', objid = '190361393344112894', columns = c('objName', 'raMean', 'decMean', 'rMeanPSFMag')) ## End(Not run)
## Not run: ps1_search( table='detection', release='dr2', objid = '190361393344112894') ps1_search( table='mean', release='dr2', objid = '190361393344112894', columns = c('objName', 'raMean', 'decMean', 'rMeanPSFMag')) ## End(Not run)