matmodel.base package

Submodules

matmodel.base.Aspect module

MAT-Tools: Python Framework for Multiple Aspect Trajectory Data Mining

The present application offers a tool, to support the user in the modeling of multiple aspect trajectory data. It integrates into a unique framework for multiple aspects trajectories and in general for multidimensional sequence data mining methods. Copyright (C) 2022, MIT license (this portion of code is subject to licensing from source project distribution)

Created on Apr, 2024 Copyright (C) 2024, License GPL Version 3 or superior (see LICENSE file)

Authors:

  • Tarlis Portela

  • Vanessa Lago Machado

class matmodel.base.Aspect.Aspect(value)[source]

Bases: object

Represents a generic attribute or ‘aspect’ of a point, such as a spatial, temporal, or categorical aspect.

Attributes:

_value:

The actual value of the aspect.

Methods:

value(units=None):

Property to get the value of the aspect.

__repr__():

Returns a string representation of the aspect.

match(asp1, asp2):

Checks if two aspects are equal.

__eq__(other):

Checks if this aspect is equal to another aspect based on its value.

match(asp1, asp2)[source]
property value
class matmodel.base.Aspect.Boolean(value)[source]

Bases: Aspect

Represents a boolean aspect. The value can be a boolean or strings that can be interpreted as boolean.

class matmodel.base.Aspect.Categoric(value)[source]

Bases: Aspect

Represents a categorical aspect. The value is treated as a string variable.

class matmodel.base.Aspect.DateTime(start, mask='%H:%M')[source]

Bases: Aspect

Represents a temporal aspect, storing date and time information.

Uni

Attributes:

start or value (datetime):

The start time of the interval.

mask (str):

The format in which the date and time is provided.

Methods:

day():

Returns the day of the month.

month():

Returns the month.

year():

Returns the year.

weekday():

Returns the day of the week (0 for Monday, 6 for Sunday).

isweekend(): C

hecks if the date falls on a weekend.

isweekday():

Checks if the date falls on a weekday.

hours():

Returns the hour of the day.

minutes():

Returns the total minutes since the start of the day.

seconds():

Returns the total seconds since the start of the day.

microseconds():

Returns the total microseconds since the start of the day.

get(units=None):

Returns the value in a specified unit (e.g., D, M, Y, etc.).

convertMinToDate(minutes):

Converts minutes to a datetime object.

convert(value, mask=None):

Converts a string value to a datetime object.

Notes:

units: The available unit codes are:

  • D: days

  • M: months

  • Y: years

  • w: weekday

  • h: hours

  • m: minutes

  • s: seconds

  • ms: microseconds

convert(value, mask=None)[source]
convertMinToDate(minutes)[source]
day()[source]
get(units=None)[source]
hours()[source]
isweekday()[source]
isweekend()[source]
microseconds()[source]
minutes()[source]
month()[source]
seconds()[source]
property start
weekday()[source]
year()[source]
class matmodel.base.Aspect.Interval(start, end, mask='%H:%M')[source]

Bases: DateTime

Represents a temporal interval between two DateTime points.

Attributes:

start or value (datetime):

The start time of the interval.

end (datetime):

The end time of the interval.

class matmodel.base.Aspect.Numeric(value)[source]

Bases: Aspect

Represents a numeric aspect, where the value is instantiated as a float.

class matmodel.base.Aspect.Rank(descriptor)[source]

Bases: Aspect

Represents a ranked aspect, containing ranked values.

Attributes:

rank_values (list):

A list of RankValue objects, each containing an aspect and its proportion.

Methods:

add(aspect, proportion):

Adds a ranked value to the rank with its proportion.

add(aspect, proportion)[source]
property descriptor
class matmodel.base.Aspect.RankValue(value, proportion)[source]

Bases: object

Represents a value in a Rank, with its corresponding proportion.

Attributes:

value (Aspect):

The aspect associated with this rank value.

proportion (float):

The proportion associated with this rank value.

class matmodel.base.Aspect.Space2D(value)[source]

Bases: Aspect

Represents a 2D spatial aspect, storing x and y coordinates.

Attributes:

x (float):

The x-coordinate (latitude).

y (float):

The y-coordinate (longitude).

property value
class matmodel.base.Aspect.Space3D(x, y, z)[source]

Bases: Space2D

Represents a 3D spatial aspect, extending the 2D space with an additional z-coordinate.

Attributes:

x (float):

The x-coordinate.

y (float):

The y-coordinate.

z (float):

The z-coordinate.

property value
matmodel.base.Aspect.instantiateAspect(k, v)[source]

Instantiates an Aspect object based on the data type specified in the DataDescriptor.

Args:

k:

DataDescriptor object that contains metadata about the attribute.

v:

The raw value to be converted into an Aspect.

Returns:

An instantiated Aspect object (e.g., Boolean, Numeric, Space2D, DateTime, etc.).

Raises:

Exception:

If the instantiation fails for any reason.

matmodel.base.MultipleAspectSequence module

MAT-Tools: Python Framework for Multiple Aspect Trajectory Data Mining

The present application offers a tool, to support the user in the modeling of multiple aspect trajectory data. It integrates into a unique framework for multiple aspects trajectories and in general for multidimensional sequence data mining methods. Copyright (C) 2022, MIT license (this portion of code is subject to licensing from source project distribution)

Created on Apr, 2024 Copyright (C) 2024, License GPL Version 3 or superior (see LICENSE file)

Authors:

  • Tarlis Portela

  • Vanessa Lago Machado

class matmodel.base.MultipleAspectSequence.MultipleAspectSequence(seq_id, new_points=None, data_desc=None)[source]

Bases: object

Represents a sequence of points with multiple aspects.

This class is designed to handle sequences of points, where each point may have multiple attributes or aspects associated with it. It provides functionalities to manipulate and analyze these sequences, including the addition of points and extraction of subsequences.

Parameters:

  • seq_id (int or str) – The identifier for the sequence (or TID - Trajectory ID).

  • new_points (list, optional) – A list of new points to initialize the sequence with. Default is None.

  • data_desc (DataDescriptor, optional) – An instance of DataDescriptor that describes the attributes of the points in the sequence. Default is None.

tid

The sequence identifier.

Type:

int or str

points

A list of Point instances representing the points in the sequence.

Type:

list

data_desc

The DataDescriptor instance associated with the sequence.

Type:

DataDescriptor

size

The number of points in the sequence.

Type:

int

readSequence(new_points, data_desc):

Reads a list of new points and populates the sequence.

addPoint(aspects, data_desc):

Adds a new point with specified aspects to the sequence.

subsequence(start, size=1, attributes_index=None):

Returns a MultipleAspectSequence subsequence of points from the sequence.

valuesOf(attributes_index, start=0, size=1):

Returns the values of the specified attributes from the subsequence.

pointValue(idx, attribute_name):

Retrieves the value of a specific attribute from a given point in the sequence.

addPoint(aspects, data_desc)[source]
property attribute_names
property attributes
property l
pointValue(idx, attribute_name)[source]
readSequence(new_points, data_desc)[source]
property size
subsequence(start, size=1, attributes_index=None)[source]
valuesOf(attributes_index, start=0, size=1)[source]
class matmodel.base.MultipleAspectSequence.Point(seq, aspects)[source]

Bases: object

Represents a point in a multiple-aspect sequence.

Each point is characterized by its index in the sequence and a set of aspects associated with it.

Parameters:

  • seq (int) – The index of the point in the sequence.

  • aspects (list) – A list of Aspect (or derrived types) representing the attributes or aspects of the point.

seq

The index of the point.

Type:

int

aspects

The aspects associated with the point.

Type:

tuple

valuesOf(attributes_index):

Retrieves the values of specified attributes from the aspects.

asString(attributes_index):

Returns a string representation of the point’s aspects.

asString(attributes_index)[source]
static fromRecord(seq, record, data_desc)[source]
property l
property p
valuesOf(attributes_index)[source]
class matmodel.base.MultipleAspectSequence.Subtrajectory(trajectory, start, points, attributes_index)[source]

Bases: MultipleAspectSequence

Represents a subsequence of a trajectory.

A Subtrajectory is derived from a Trajectory and contains a subset of points along with information about the attributes being analyzed.

Parameters:

  • trajectory (Trajectory) – The original trajectory from which this subsequence is derived.

  • start (int) – The starting index of the point of the subsequence in the original trajectory.

  • points (list) – A list of points that constitute the subsequence.

  • attributes_index (list) – The indices of attributes being analyzed in this subsequence.

attributes_index

The indices of attributes that belong to the analysis.

Type:

list

s

A formatted string representation of the subsequence.

Type:

str

attribute(index):

Retrieves an attribute by its index.

values():

Returns the values of the specified attributes from the subsequence.

property S
attribute(index)[source]
property attributes
property attributes_index
property s
values()[source]
valuesOf(attributes_index)[source]
class matmodel.base.MultipleAspectSequence.Trajectory(tid, label, new_points, data_desc)[source]

Bases: MultipleAspectSequence

Represents a trajectory composed of multiple points.

A trajectory is a special type of MultipleAspectSequence that includes a label for identification purposes.

Parameters:

  • tid (int or str) – The identifier for the trajectory (ID).

  • label (str) – A label associated with the trajectory.

  • new_points (list) – A list of initial points for the trajectory.

  • data_desc (DataDescriptor) – An instance describing the attributes of the points in the trajectory.

T

A formatted string representation of the trajectory identifier.

Type:

str

label

The label of the trajectory.

Type:

str

display():

Prints a detailed representation of the trajectory.

subtrajectory(start, size=1, attributes_index=None):

Returns a Subtrajectory object representing a subsequence of the trajectory.

property T
display()[source]
subtrajectory(start, size=1, attributes_index=None)[source]

Module contents