brapi_post_search_images: post /search/images

In mverouden/brapir-v1: 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 = "",
  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 = ""
)

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 Id, or a full ontology URL.; 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; One geometry as defined by GeoJSON (RFC 7946). All coordinates are decimal values on the WGS84 geographic coordinate reference system.
imageNames	vector of type character; required: FALSE; Human readable names to search for.; default: "", when using multiple values supply as c("value1", "value2").
imageTimeStampRangeEnd	character; required: FALSE; The latest timestamp to search for.; default: "".
imageTimeStampRangeStart	character; required: FALSE; The earliest timestamp to search for.; default: "".
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.; default: "", when using multiple values supply as c("value1", "value2").
observationDbIds	vector of type character; required: FALSE; A list of observation Ids 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 observation unit identifiers to search for.; default: "", when using multiple values supply as c("value1", "value2").

Details

Get filtered set of image meta data

• imageLocation argument should be provided as a list. The easiest way in R to construct such a list is to use the geojsonR package. Below in the example section examples are provided to create an imageLocation object for a point and a polygon.

• descriptiveOntologyTerm can be thought of as Tags for the image. These could be simple descriptive words, or ontology references, or full ontology URI's.

Value

data.frame

Author(s)

brapir generator package

References

BrAPI SwaggerHub

See Also

Other brapi_1.3: brapi_get_allelematrices_search(), brapi_get_allelematrices(), brapi_get_attributes_categories(), brapi_get_attributes(), brapi_get_breedingmethods_breedingMethodDbId(), brapi_get_breedingmethods(), brapi_get_calls(), brapi_get_commoncropnames(), brapi_get_germplasm_germplasmDbId_attributes(), brapi_get_germplasm_germplasmDbId_markerprofiles(), brapi_get_germplasm_germplasmDbId_mcpd(), brapi_get_germplasm_germplasmDbId_pedigree(), brapi_get_germplasm_germplasmDbId_progeny(), brapi_get_germplasm_germplasmDbId(), brapi_get_germplasm(), brapi_get_images_imageDbId(), brapi_get_images(), brapi_get_lists_listDbId(), brapi_get_lists(), brapi_get_locations_locationDbId(), brapi_get_locations(), brapi_get_maps_mapDbId_positions_linkageGroupName(), brapi_get_maps_mapDbId_positions(), brapi_get_maps_mapDbId(), brapi_get_maps(), brapi_get_markerprofiles_markerProfileDbId(), brapi_get_markerprofiles(), brapi_get_markers_markerDbId(), brapi_get_markers(), brapi_get_methods_methodDbId(), brapi_get_methods(), brapi_get_observationlevels(), brapi_get_observationunits(), brapi_get_ontologies(), brapi_get_people_personDbId(), brapi_get_people(), brapi_get_programs(), brapi_get_samples_sampleDbId(), brapi_get_samples(), brapi_get_scales_scaleDbId(), brapi_get_scales(), brapi_get_search_germplasm_searchResultsDbId(), brapi_get_search_images_searchResultsDbId(), brapi_get_search_markers_searchResultsDbId(), brapi_get_search_observationtables_searchResultsDbId(), brapi_get_search_observationunits_searchResultsDbId(), brapi_get_search_programs_searchResultsDbId(), brapi_get_search_samples_searchResultsDbId(), brapi_get_search_studies_searchResultsDbId(), brapi_get_search_variables_searchResultsDbId(), brapi_get_seasons(), brapi_get_studies_studyDbId_germplasm(), brapi_get_studies_studyDbId_layouts(), brapi_get_studies_studyDbId_observations(), brapi_get_studies_studyDbId_observationunits(), brapi_get_studies_studyDbId_observationvariables(), brapi_get_studies_studyDbId_table(), brapi_get_studies_studyDbId(), brapi_get_studies(), brapi_get_studytypes(), brapi_get_traits_traitDbId(), brapi_get_traits(), brapi_get_trials_trialDbId(), brapi_get_trials(), brapi_get_variables_observationVariableDbId(), brapi_get_variables(), brapi_get_vendor_orders_orderId_plates(), brapi_get_vendor_orders_orderId_results(), brapi_get_vendor_orders_orderId_status(), brapi_get_vendor_orders(), brapi_get_vendor_plates_submissionId(), brapi_get_vendor_specifications(), brapi_post_allelematrices_search(), brapi_post_images(), brapi_post_lists_listDbId_items(), brapi_post_lists(), brapi_post_methods(), brapi_post_people(), brapi_post_phenotypes(), brapi_post_scales(), brapi_post_search_germplasm(), brapi_post_search_markers(), brapi_post_search_observationtables(), brapi_post_search_observationunits(), brapi_post_search_programs(), brapi_post_search_samples(), brapi_post_search_studies(), brapi_post_search_variables(), brapi_post_studies_studyDbId_table(), brapi_post_traits(), brapi_post_vendor_orders(), brapi_post_vendor_plates(), brapi_put_images_imageDbId_imagecontent(), brapi_put_images_imageDbId(), brapi_put_lists_listDbId(), brapi_put_methods_methodDbId(), brapi_put_people_personDbId(), brapi_put_samples(), brapi_put_scales_scaleDbId(), brapi_put_studies_studyDbId_layouts(), brapi_put_studies_studyDbId_observations(), brapi_put_studies_studyDbId_observationunits(), brapi_put_traits_traitDbId()

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()

Other Search Services: brapi_get_search_germplasm_searchResultsDbId(), brapi_get_search_images_searchResultsDbId(), brapi_get_search_markers_searchResultsDbId(), brapi_get_search_observationtables_searchResultsDbId(), brapi_get_search_observationunits_searchResultsDbId(), brapi_get_search_programs_searchResultsDbId(), brapi_get_search_samples_searchResultsDbId(), brapi_get_search_studies_searchResultsDbId(), brapi_get_search_variables_searchResultsDbId(), brapi_post_search_germplasm(), brapi_post_search_markers(), brapi_post_search_observationtables(), brapi_post_search_observationunits(), brapi_post_search_programs(), brapi_post_search_samples(), brapi_post_search_studies(), brapi_post_search_variables()

Examples

## Not run: 

# Create a connection object
con <- brapi_db()$testserver

library(geojsonR)
# Create on imageLocation example objects
#' # Point example for Ancient Human Head at Cypress County, Canada
init <- TO_GeoJson$new()
imageLocation <- list()
pointData <- c(-110.11301, 50.010082) # provide as c(longitude, latitude. altitude)
imageLocation[["geometry"]] <- init$Point(data = pointData, stringify = FALSE)
imageLocation$type <- "Feature"

# Polygon example with exterior and an interior ring
# The first list in polygonData creates the exterior ring, whereas
# following lists create interior rings.
init <- TO_GeoJson$new()
# Polygon data points are provided as c(longitude, latitude)
polygonData <- list(list(c(-76.476949, 42.447274), # exterior ring (rectangle)
                         c(-76.474429, 42.447258),
                         c(-76.474428, 42.446193),
                         c(-76.476961, 42.446211),
                         c(-76.476949, 42.447274)),
                    list(c(-76.476733, 42.446916), # interior ring (triangle)
                         c(-76.475810, 42.447154),
                         c(-76.476306, 42.446281),
                         c(-76.476733, 42.446916)))
imageLocation2 <- list()
imageLocation2[["geometry"]] <- init$Polygon(data = polygonData, stringify = FALSE)
imageLocation2$type <- "Feature"

# Make post /search/images call
# For the Point location example
searchResultsDbId <- brapi_post_search_images(con = con, imageLocation = imageLocation)
searchResultsDbId <- as.character(searchResultsDbId)

# For the Polygon location example
searchResultsDbId <- brapi_post_search_images(con = con, imageLocation = imageLocation2)
searchResultsDbId <- as.character(searchResultsDbId)

## End(Not run)

mverouden/brapir-v1 documentation built on April 11, 2022, 9:17 a.m.