sarapy 0.2.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

sarapy/dataProcessing/GeoAnalyzer.py

@@ -1,12 +1,4 @@
-"""
-La clase GeoAnalyzer se encarga de gestionar los datos de georreferenciación.
-
-- Versión de metadatos utilizada: Revision 9
-- Apuntes de desarrollo: https://docs.google.com/document/d/1kVH-DS6d572AObMCW5oRBIkn357C0T0XXZbq6C2KuW8/edit#heading=h.qfw1towwg3ot
-
-- Autor: BALDEZZARI Lucas
-- Creación: 8 de enero de 2024
-"""
+###Documentación en https://github.com/lucasbaldezzari/sarapy/blob/main/docs/Readme.md
 
 import numpy as np
 from geopy.distance import geodesic
@@ -14,16 +6,7 @@ from sklearn.base import BaseEstimator, TransformerMixin
 import warnings
 
 class GeoAnalyzer(BaseEstimator, TransformerMixin):
-    """La clase GeoAnalyzer se encarga de gestionar los datos de georreferenciación.
-
-    - Versión de metadatos utilizada: Revision 9
-    - Apuntes de desarrollo: https://docs.google.com/document/d/1kVH-DS6d572AObMCW5oRBIkn357C0T0XXZbq6C2KuW8/edit#heading=h.qfw1towwg3ot
-    - Apuntes de
-    - Apuntes de Desarrollo: 
-
-    - Autor: BALDEZZARI Lucas
-    - Version: 0.1.0
-    """
+    """La clase GeoAnalyzer se encarga de gestionar los datos de georreferenciación."""
     
     # _GeoPoint = Tuple[float, float]
     
@@ -37,7 +20,7 @@ class GeoAnalyzer(BaseEstimator, TransformerMixin):
     def getDistance(point1: np.array, point2: np.array) ->float:
         """Calcula la distancia elipsoidal (en metros) entre los puntos p1 y p2 donde cada punto está representado como un array con un valor de latitud y otro de longitud. 
 
-        Args:
+        Parametros
             p1 (tuple): np.array de tuplas con las coordenadas de latitud y longitud del punto 1
             p2 (tuple): np.array de tuplas con las coordenadas de latitud y longitud del punto 2
 
@@ -52,7 +35,6 @@ class GeoAnalyzer(BaseEstimator, TransformerMixin):
         """fittea el objeto
         
         - X: array con los puntos de latitud y longitud. Shape (n, 2)
-        - y: etiquetas de entrenamiento
         """
         ##asserteamos que X sea un np.array
         assert isinstance(X, np.ndarray), "X debe ser un np.array"

sarapy/dataProcessing/TLMSensorDataExtractor.py

@@ -1,40 +1,15 @@
-"""
-La clase TLMSensorDataExtractor se encarga de gestionar los metadatos obtenidos de la base de datos. Estos metadatos se corresponden con los datos registrados en los sarapicos.
+###Documentación en https://github.com/lucasbaldezzari/sarapy/blob/main/docs/Readme.md
 
-- Versión de metadatos utilizada: Revision 9
-- Apuntes de desarrollo: https://docs.google.com/document/d/1kVH-DS6d572AObMCW5oRBIkn357C0T0XXZbq6C2KuW8/edit#heading=h.qfw1towwg3ot
-
-- Autor: BALDEZZARI Lucas
-"""
-
-##importamos numpy
 import numpy as np
 from sklearn.base import BaseEstimator, TransformerMixin
 
 class TLMSensorDataExtractor(BaseEstimator, TransformerMixin):
-    """
-    Clase que se encarga de procesar los metadatos obtenidos de la base de datos histórica.
-
-    - Versión de metadatos utilizada: Revision 9 
-    - Link documento metadato: https://trello.com/c/M6DWjpwr/70-definici%C3%B3n-metadatos-a-relevar
-    - Los metadatos de DATA_TLM en la Revisión 9 vienen en un string de 0 y 1. Estos valores indican, lo siguiente:
-    |RF(1bit)|GNSS(1bit)|RFID(1bit)|FLASH(1bit)|RTCS(1bit)|MODE(1bit)|NBAT(2bits)|TIMEAC(8bits)|ESTAC(1bit)|DSTR PT(4bits)|INEST PT(1bit)|OFFS PT(2bits)|X(1bit)|DSTR FT(4bits)|INEST FT(1bit)|OFFS FT(2bits)|X(1bit)|GYRO_X(3bits)|GYRO_Y(3bits)|GYRO_Z(2bits)|ACEL_X(2bits)|ACEL_Y(2bits)|ACEL_Z(2bits)|EST MO(1bit)|EST OR(1bit)|SBAT(2bits)|VBAT(3bits)|CBAT(2bits)|EST BMS(1bit)
-    
-    Los valores X indican bit sin uso.
-
-    - Versión 0.2.0.RevA
-    - Autor: BALDEZZARI Lucas
-    """
+    """- Autor: BALDEZZARI Lucas"""
     
     __metadataVersion = "Revision 9" #Versión de metadatos utilizada
 
     def __init__(self, *args, **kwargs):
-        """
-        Constructor de la clase MetadataManager.
-
-        :param metadata: Diccionario con los metadatos obtenidos de la base de datos.
-        :type metadata: strg
-        """
+        """Constructor de la clase MetadataManager."""
 
         ### Creamos constantes que sirven para buscar los datos en el string de telemetría
         ### Cada constante es una tupla con la posición del bit menos significativo y la posición del bit más significativo
@@ -71,19 +46,7 @@ class TLMSensorDataExtractor(BaseEstimator, TransformerMixin):
         self.is_fitted = False
 
     def fit(self, X, y=None):
-        """
-        Método para generar datos a partir de la metadata.
-
-        X es un array de strings. Cada string es un dato de la metadata.
-
-        Extraigo información de cada fila de X. Genero numpys array de cada dato extraido de la metadata.
-
-        Parametros
-        ----------
-            X: Array de strings.
-            y: None
-                No se utiliza.
-        """
+        """Método para generar datos a partir de la metadata."""
 
         ##chequeamos si todos los strings de X tienen la misma longitud, sino arrojamos un assert
         assert all(len(x) == len(X[0]) for x in X), "Todos los strings de X deben tener la misma longitud"
@@ -121,15 +84,8 @@ class TLMSensorDataExtractor(BaseEstimator, TransformerMixin):
 
 
     def transform(self, X, y=None):
-        """Genera un array de numpy con los datos extraidos de la metadata.
-        
-        Forma una matriz de numpy.
-        
-        Parametros
-        ----------
-            X: X es un array de strings. Cada string es un dato de la metadata.
-            y: None
-                No se utiliza."""
+        """
+                """
         
         ##chequeamos si se ha llamado a fit(). Sino, se arroja un error
         if not self.is_fitted:
@@ -165,19 +121,7 @@ class TLMSensorDataExtractor(BaseEstimator, TransformerMixin):
                             self._ESTBMSFlag]).T
 
     def fit_transform(self, X, y=None):
-        """Combinamos fit() y transform() en un solo método.
-        
-        Parametros
-        ----------
-            X: X es un array de strings. Cada string es un dato de la metadata.
-            y: None
-                No se utiliza.
-        
-        Return
-        ------
-            numpy array:
-                Array de numpy con los datos extraidos de la metadata.
-                """
+        """Combinamos fit() y transform() en un solo método."""
         self.fit(X)
         return self.transform(X)
 

sarapy/dataProcessing/TimeSeriesProcessor.py

@@ -1,31 +1,14 @@
-"""
-La clase TimeSeriesProcessor se encarga de obtener y gestionar los datos referentes a las series temporales del Sarapico.
-
-- Versión de metadatos utilizada: Revision 9
-- Apuntes de desarrollo: https://docs.google.com/document/d/1kVH-DS6d572AObMCW5oRBIkn357C0T0XXZbq6C2KuW8/edit#heading=h.qfw1towwg3ot
-
-- Autor: BALDEZZARI Lucas
-- Creación: 8 de enero de 2024
-"""
+###Documentación en https://github.com/lucasbaldezzari/sarapy/blob/main/docs/Readme.md
 
 import numpy as np
 from sklearn.base import BaseEstimator, TransformerMixin
 import warnings
 from datetime import datetime
 
-
 class TimeSeriesProcessor(BaseEstimator, TransformerMixin):
-    """
-    La clase TimeSeriesProcessor se encarga de obtener y gestionar los datos referentes a las series temporales del Sarapico.
-    
-    El objetivo de esta clase es poder obtener los tiempos de Operación, Caminata y Pico abierto correspondiente a las operaciones.
-
-    - Versión de metadatos utilizada: Revision 9
-    - Apuntes de desarrollo: https://docs.google.com/document/d/1kVH-DS6d572AObMCW5oRBIkn357C0T0XXZbq6C2KuW8/edit#heading=h.qfw1towwg3ot
-
+    """"
     - Autor: BALDEZZARI Lucas
     - Creación: 8 de enero de 2024
-    - Version: 0.1.0
     """
     
     def __init__(self):
@@ -34,13 +17,7 @@ class TimeSeriesProcessor(BaseEstimator, TransformerMixin):
         self.is_fitted = False
         
     def fit(self, X: np.array, y=None)-> np.array:
-        """fittea el objeto
-        
-        - X: array con los datos de timestamp (fecha y hora) en formato Unix timestamp y tiempo de pico abierto. Shape (n, 2). Los datos de Unix timestamp están en segundos.
-        
-        Returns:
-            self: objeto fitteado
-        """
+        """Fittea el objeto"""
 
         ##asserteamos que X sea un np.array
         assert isinstance(X, np.ndarray), "X debe ser un np.array"
@@ -65,14 +42,8 @@ class TimeSeriesProcessor(BaseEstimator, TransformerMixin):
         
         self.is_fitted = True
     
-    def transform(self, X: np.array ):
-        """Genera un array con los tiempos de operación, caminata y pico abierto.
-        
-        - X: array con los datos de timestamp (fecha y hora) en formato Unix timestamp y tiempo de pico abierto. Shape (n, 2). Los datos de Unix timestamp están en segundos.
-        
-        Returns:
-            np.array: array con los tiempos de operación, caminata y pico abierto. Shape (n, 3).
-        """
+    def transform(self, X: np.array):
+        """Genera un array con los tiempos de operación, caminata y pico abierto."""
         
         if not self.is_fitted:
             raise RuntimeError("El modelo no ha sido fitteado.")
@@ -80,14 +51,6 @@ class TimeSeriesProcessor(BaseEstimator, TransformerMixin):
         return np.hstack((self._deltaO.reshape(-1, 1), self._deltaC.reshape(-1, 1), self._deltaP.reshape(-1, 1))).round(2)
     
     def fit_transform(self, X: np.array, y=None):
-        """fittea el objeto y genera un array con los tiempos de operación, caminata y pico abierto.
-        
-        - X: array con los datos de timestamp (fecha y hora) en formato Unix timestamp y tiempo de pico abierto. Shape (n, 2). Los datos de Unix timestamp están en segundos.
-        
-        Returns:
-            np.array: array con los tiempos de operación, caminata y pico abierto. Shape (n, 3).
-        """
-        
         self.fit(X)
         return self.transform(X)
     

sarapy/dataProcessing/__init__.py

@@ -1,2 +1,3 @@
 from .TLMSensorDataExtractor import TLMSensorDataExtractor
-from .GeoAnalyzer import GeoAnalyzer
+from .GeoAnalyzer import GeoAnalyzer
+from .TimeSeriesProcessor import TimeSeriesProcessor

sarapy/version.py

@@ -1,2 +1,2 @@
 ## Version of the package   
-__version__ = "0.2.0"
+__version__ = "0.2.1"

{sarapy-0.2.0.dist-info → sarapy-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sarapy
-Version: 0.2.0
+Version: 0.2.1
 Summary: Library for Sarapico Metadata processing
 Home-page: https://github.com/lucasbaldezzari/sarapy
 Author: Lucas Baldezzari
@@ -24,6 +24,10 @@ Requires-Dist: geopy
 
 Library for processing SARAPICO project metadata of _AMG_.
 
+#### Version 0.2.1
+
+- Se corrige _init.py_ de dataProcessing.
+
 #### Version 0.2.0
 
 - Transforming some attributs to private attributes. Adding @property for getters.

sarapy-0.2.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+sarapy/__init__.py,sha256=aVoywqGSscYYDycLaYJnz08dlQabl9gH0h4Q5KtHM9o,74
+sarapy/version.py,sha256=gV4G8Od3LgDPbdxJK6oi8C-5N5hfwtY0SK2GQjYwDZ0,51
+sarapy/dataProcessing/GeoAnalyzer.py,sha256=U6J0h7jtBeVDUL9HfglA8vyI2_espL96FKT5lFSaICE,4292
+sarapy/dataProcessing/TLMSensorDataExtractor.py,sha256=KM1TQBKKnkN-zjX9jCDSvpQ9we_FCxqp-4gFD-SX964,21446
+sarapy/dataProcessing/TimeSeriesProcessor.py,sha256=vEoHyhgZHSI48Fb3f646EAb13jyRYedBIF1S6-_9oQM,4210
+sarapy/dataProcessing/__init__.py,sha256=3CKfXN4KZnxFdZDzwX5_a03gqG5hsEC1AXbT7AZyjf0,150
+sarapy-0.2.1.dist-info/METADATA,sha256=R1ovUgS3jF_tjZSLgNrwF8KfH4lCian_OeFM4wTQH6c,1402
+sarapy-0.2.1.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+sarapy-0.2.1.dist-info/top_level.txt,sha256=4mUGZXfX2Fw47fpY6MQkaJeuOs_8tbjLkkNp34DJWiA,7
+sarapy-0.2.1.dist-info/RECORD,,

sarapy-0.2.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-sarapy/__init__.py,sha256=aVoywqGSscYYDycLaYJnz08dlQabl9gH0h4Q5KtHM9o,74
-sarapy/version.py,sha256=qxTsxev69Rcevv5-3XjGuTotIjAm7PaJWnqimjekEkc,51
-sarapy/dataProcessing/GeoAnalyzer.py,sha256=CGNQq35zTeDLfN6FbqVcAP5-yafw58-1eSXYJ7CPgJ4,4875
-sarapy/dataProcessing/TLMSensorDataExtractor.py,sha256=s-2gpajsS_5bCyefrgITHE1Xs0JMsq_VQAjeZIhrZWM,23698
-sarapy/dataProcessing/TimeSeriesProcessor.py,sha256=IEXLr6qYYJbcASYHfOKt9uN-48ek45tC6iVMY3OEJfE,6004
-sarapy/dataProcessing/__init__.py,sha256=XQAq8XaCeyg3Cd4l47rF9sXC0d7e5t9CcW3328vcUtk,96
-sarapy-0.2.0.dist-info/METADATA,sha256=SWLvQjiQurbSKGDUK4_XOHE5yhBuTlyO2BE9dpej5Sw,1335
-sarapy-0.2.0.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-sarapy-0.2.0.dist-info/top_level.txt,sha256=4mUGZXfX2Fw47fpY6MQkaJeuOs_8tbjLkkNp34DJWiA,7
-sarapy-0.2.0.dist-info/RECORD,,