OmeroBlitz API

omero::grid::Table

Overview

[ "ami" ] interface Table

Operation Index

getOriginalFile
getHeaders: Returns empty columns.
getNumberOfRows
getWhereList: http://www.pytables.org/docs/manual/apb.html Leave all three of start, stop, step to 0 to disable.
readCoordinates: Read the given rows of data.
read: http://www.pytables.org/docs/manual/ch04.html#Table.read
slice: Simple slice method which will return only the given columns and rows in the order supplied.
addData
update: Allows the user to modify a Data instance passed back from a query method and have the values modified.
getAllMetadata
getMetadata
setAllMetadata
setMetadata
initialize: Initializes the structure based on
addColumn: Adds a column and returns the position index of the new column.
delete
close

Operations

model::OriginalFile getOriginalFile() throws ServerError

ColumnArray getHeaders() throws ServerError

Returns empty columns.

long getNumberOfRows() throws ServerError

api::LongArray getWhereList(string condition, RTypeDict variables, long start, long stop, long step) throws ServerError

http://www.pytables.org/docs/manual/apb.html Leave all three of start, stop, step to 0 to disable. TODO:Test effect of returning a billion rows matching getWhereList()

Data readCoordinates(api::LongArray rowNumbers) throws ServerError

Read the given rows of data.

Parameters

rowNumbers: must contain at least one element or an ApiUsageException will be thrown.

Data read(api::LongArray colNumbers, long start, long stop) throws ServerError

http://www.pytables.org/docs/manual/ch04.html#Table.read

Data slice(api::LongArray colNumbers, api::LongArray rowNumbers) throws ServerError

Simple slice method which will return only the given columns and rows in the order supplied. If colNumbers or rowNumbers is empty (or None), then all values will be returned.

Python examples:

data = table.slice(None, None)
assert len(data.rowNumbers) == table.getNumberOfRows()

data = table.slice(None, [3,2,1])
assert data.rowNumbers == [3,2,1]

void addData(ColumnArray cols) throws ServerError

void update(Data modifiedData) throws ServerError

Allows the user to modify a Data instance passed back from a query method and have the values modified. It is critical that the {@code Data.lastModification} and the {@code Data.rowNumbers} fields are properly set. An exception will be thrown if the data has since been modified.

RTypeDict getAllMetadata() throws ServerError

RType getMetadata(string key) throws ServerError

void setAllMetadata(RTypeDict dict) throws ServerError

void setMetadata(string key, RType value) throws ServerError

void initialize(ColumnArray cols) throws ServerError

Initializes the structure based on

int addColumn(Column col) throws ServerError

Adds a column and returns the position index of the new column.

void delete() throws ServerError

void close() throws ServerError

Home

Index