brapi_post_search_images: post /search/images

In mverouden/brapir-v2: Client to Access BrAPI Compliant Plant Breeding Databases

post /search/images

Description

Submit a search request for images

Usage

brapi_post_search_images(
  con = NULL,
  descriptiveOntologyTerms = "",
  externalReferenceIDs = "",
  externalReferenceSources = "",
  imageDbIds = "",
  imageFileNames = "",
  imageFileSizeMax = as.integer(NA),
  imageFileSizeMin = as.integer(NA),
  imageHeightMax = as.integer(NA),
  imageHeightMin = as.integer(NA),
  imageLocation = list(),
  imageNames = "",
  imageTimeStampRangeEnd = "",
  imageTimeStampRangeStart = "",
  imageWidthMax = as.integer(NA),
  imageWidthMin = as.integer(NA),
  mimeTypes = "",
  observationDbIds = "",
  observationUnitDbIds = "",
  page = 0,
  pageSize = 1000
)

Arguments

con	list; required: TRUE; BrAPI connection object
descriptiveOntologyTerms	vector of type character; required: FALSE; A list of terms to formally describe the image to search for. Each item could be a simple Tag, an Ontology reference identifier, or a full ontology URL.; default: "", when using multiple values supply as c("value1", "value2").
externalReferenceIDs	vector of type character; required: FALSE; External reference identifier(s) to search for. Could be a simple strings or a URIs (use with externalReferenceSources parameter).; default: "", when using multiple values supply as c("value1", "value2").
externalReferenceSources	vector of type character; required: FALSE; Source system or database identifier(s) of an external reference(s) to search for (use with externalReferenceIDs parameter); default: "", when using multiple values supply as c("value1", "value2").
imageDbIds	vector of type character; required: FALSE; A list of unique database identifiers of images to search for; default: "", when using multiple values supply as c("value1", "value2").
imageFileNames	vector of type character; required: FALSE; Image file names to search for.; default: "", when using multiple values supply as c("value1", "value2").
imageFileSizeMax	integer; required: FALSE; A maximum image file size to search for.
imageFileSizeMin	integer; required: FALSE; A minimum image file size to search for.
imageHeightMax	integer; required: FALSE; A maximum image height to search for.
imageHeightMin	integer; required: FALSE; A minimum image height to search for.
imageLocation	list; required: FALSE; A GeoJSON Polygon geometry, as defined by GeoJSON (RFC 7946), which describes an area to search for other GeoJSON objects. All contained Points and intersecting Polygons are returned as search results. The coordinates are decimal values on the WGS84 geographic coordinate reference system. A coordinate position MUST be two or more elements. The first two elements are longitude and latitude, or easting and northing, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element and is specified in meters. The coordinates list MUST contain the following two elements: geometry as a list; required: TRUE; A geometry as defined by GeoJSON (RFC 7946). In this context, only Polygon geometry is allowed. The Polygon geometry is described by exactly two elements: coordinates as a list; required : TRUE; List of linear rings, where each linear ring is a list of at least four positions with the first equal to the last. The first linear ring specifies the exterior ring, and each subsequent ring an interior ring. type as a character; required: TRUE; Literally specified as "Polygon". type as a character; required: TRUE; Literally specified as "Feature". The easiest way in R to construct the imageLocation list is to use the geojsonR package. The Examples section shows how to create a imageLocation list object for a polygon geometry.
imageNames	vector of type character; required: FALSE; Human readable image names to search for.; default: "", when using multiple values supply as c("value1", "value2").
imageTimeStampRangeEnd	character; required: FALSE; Time stamp to end the range for images to filter on. Coded in the ISO 8601 standard extended format, where date, time and time zone information needs to be provided (check for example https://www.w3.org/TR/NOTE-datetime).
imageTimeStampRangeStart	character; required: FALSE; Time stamp to start the range for images to filter on. Coded in the ISO 8601 standard extended format, where date, time and time zone information needs to be provided (check for example https://www.w3.org/TR/NOTE-datetime).
imageWidthMax	integer; required: FALSE; A maximum image width to search for.
imageWidthMin	integer; required: FALSE; A minimum image width to search for.
mimeTypes	vector of type character; required: FALSE; A set of image file types to search for, pattern to use "image/*" e.g. "image/jpg", "image/jpeg", "image/gif"; default: "", when using multiple values supply as c("value1", "value2").
observationDbIds	vector of type character; required: FALSE; A list of unique observation database identifiers this image is associated with to search for; default: "", when using multiple values supply as c("value1", "value2").
observationUnitDbIds	vector of type character; required: FALSE; A set of unique observation unit database identifiers to search for.; default: "", when using multiple values supply as c("value1", "value2").
page	integer; required: FALSE; Used to request a specific page of data to be returned. The page indexing starts at 0 (the first page is page = 0). Default is 0.
pageSize	integer; required: FALSE; The size of the pages to be returned. Default is 1000.

Details

Submit a search request for Images. Function will return either the search results (Status 200 for an immediate response) or a searchResultsDbId (Status 202 for both a saved and an asynchronous search).

Value

data.frame

Author(s)

Maikel Verouden

References

BrAPI SwaggerHub

See Also

Other brapi-phenotyping: brapi_get_events(), brapi_get_images_imageDbId(), brapi_get_images(), brapi_get_methods_methodDbId(), brapi_get_methods(), brapi_get_observationlevels(), brapi_get_observations_observationDbId(), brapi_get_observations_table(), brapi_get_observations(), brapi_get_observationunits_observationUnitDbId(), brapi_get_observationunits_table(), brapi_get_observationunits(), brapi_get_ontologies(), brapi_get_scales_scaleDbId(), brapi_get_scales(), brapi_get_search_images_searchResultsDbId(), brapi_get_search_observations_searchResultsDbId(), brapi_get_search_observationunits_searchResultsDbId(), brapi_get_search_variables_searchResultsDbId(), brapi_get_traits_traitDbId(), brapi_get_traits(), brapi_get_variables_observationVariableDbId(), brapi_get_variables(), brapi_post_images(), brapi_post_methods(), brapi_post_observations(), brapi_post_observationunits(), brapi_post_scales(), brapi_post_search_observations(), brapi_post_search_observationunits(), brapi_post_search_variables(), brapi_post_traits(), brapi_post_variables(), brapi_put_images_imageDbId_imagecontent(), brapi_put_images_imageDbId(), brapi_put_methods_methodDbId(), brapi_put_observations_observationDbId(), brapi_put_observationunits_observationUnitDbId(), brapi_put_scales_scaleDbId(), brapi_put_traits_traitDbId(), brapi_put_variables_observationVariableDbId()

Other Images: brapi_get_images_imageDbId(), brapi_get_images(), brapi_get_search_images_searchResultsDbId(), brapi_post_images(), brapi_put_images_imageDbId_imagecontent(), brapi_put_images_imageDbId()

Examples

## Not run: 
con <- brapi_db()$testserver
con[["token"]] <- "YYYY"

## Create a imageLocation list object
library(geojsonR)
## Polygon geometry with an exterior ring only
init <- TO_GeoJson$new()
## Individual polygon points are provided as c(longitude, latitude, altitude)
polygonData <- list(list(c(-76.476949, 42.447274, 123), # exterior ring (rectangle)
                         c(-76.474429, 42.447258, 123),
                         c(-76.474428, 42.446193, 123),
                         c(-76.476961, 42.446211, 123),
                         c(-76.476949, 42.447274, 123)))
imageLocation <- list()
imageLocation[["geometry"]] <- init$Polygon(data = polygonData,
                                            stringify = FALSE)
imageLocation[["type"]] <- "Feature"

# Immediate Response Example
brapi_post_search_images(con = con,
                         page = 0,
                         pageSize = 1000)

# Saved or Asynchronous Search Response Example
brapi_post_search_images(con = con,
                         imageDbIds = c("image1",
                                        "image2"),
                         imageWidthMax = 1920,
                         imageWidthMin = 100,
                         mimeTypes = c("image/jpg",
                                       "image/jpeg",
                                       "image/gif"))

## End(Not run)

mverouden/brapir-v2 documentation built on April 22, 2022, 9:24 a.m.