Skip to content

Reference

ImxMultiRepo

Bases: ImxMultiRepoProtocol

get_pandas_df(types=None, paths=None, pivot_df=False)

Returns a Pandas DataFrame of the filtered objects based on type and path.

get_pandas_df_dict(pivot_df=False)

Returns a dictionary of DataFrames, one for each unique path.

get_pandas_df_overview()

Generates a DataFrame with specific population properties.

get_keys()

Returns the set of keys currently in the tree dictionary.

Returns:

Type Description
list[str]

The set of keys in the tree dictionary.

find(key)

Returns all ImxObject instances for a given key (puic), maintaining container order.

get_all()

Returns a list of tuples for each ImxObject, maintaining container order.

get_all_types()

Returns all unique types (tags) of ImxObject instances.

get_by_types(object_types)

Returns all items by given types, will check first type of object.

get_all_paths()

Returns all unique paths of ImxObject instances.

get_by_paths(object_paths)

Returns all items by given paths, ensuring at least one item matches the paths.

get_pandas(types=None, paths=None, pivot_df=False)

Returns a Pandas DataFrame of the filtered objects based on type and path.

get_pandas_dict(pivot_df=False)

Returns a dictionary of DataFrames, one for each unique path.

get_geojson(object_path, container_id, as_wgs=True, extension_properties=False)

Generate a GeoJSON feature collection from a list of object types or paths.

create_geojson_files(directory_path, container_id, as_wgs=True, extension_properties=False)

Create GeoJSON files for the specified object types or paths and save them to the given directory.

ImxMultiRepoObject

get_by_container_id(container_id)

Retrieve the ImxObject for a specific container.