allensdk.api.queries.annotated_section_data_sets_api module

class allensdk.api.queries.annotated_section_data_sets_api.AnnotatedSectionDataSetsApi(base_uri=None)[source]

Bases: allensdk.api.queries.rma_api.RmaApi

See: Searching Annotated SectionDataSets

get_annotated_section_data_sets(structures, intensity_values=None, density_values=None, pattern_values=None, age_names=None)[source]

For a list of target structures, find the SectionDataSet that matches the parameters for intensity_values, density_values, pattern_values, and Age.

Parameters:
structure_graph_id : dict of integers

what to retrieve

intensity_values : array of strings, optional

‘High’,’Low’, ‘Medium’ (default)

density_values : array of strings, optional

‘High’, ‘Low’

pattern_values : array of strings, optional

‘Full’

age_names : array of strings, options

for example ‘E11.5’, ‘13.5’

Returns:
data : dict

The parsed JSON repsonse message.

Notes

This method uses the non-RMA Annotated SectionDataSet endpoint.

get_annotated_section_data_sets_via_rma(**kwargs)[source]

For a list of target structures, find the SectionDataSet that matches the parameters for intensity_values, density_values, pattern_values, and Age.

Parameters:
structure_graph_id : dict of integers

what to retrieve

intensity_values : array of strings, optional

intensity values, ‘High’,’Low’, ‘Medium’ (default)

density_values : array of strings, optional

density values, ‘High’, ‘Low’

pattern_values : array of strings, optional

pattern values, ‘Full’

age_names : array of strings, options

for example ‘E11.5’, ‘13.5’

Returns:
data : dict

The parsed JSON response message.

Notes

This method uses the RMA endpoint to search annotated SectionDataSet data.

get_compound_annotated_section_data_sets(queries, fmt='json')[source]

Find the SectionDataSet that matches several annotated_section_data_sets queries linked together with a Boolean ‘and’ or ‘or’.

Parameters:
queries : array of dicts

dicts with args like build_query

fmt : string, optional

‘json’ or ‘xml’

Returns:
data : dict

The parsed JSON repsonse message.