Skip to content

Commit

Permalink
Fix typos in libs/ subdirectory
Browse files Browse the repository at this point in the history
  • Loading branch information
luzpaz committed Dec 2, 2023
1 parent 32dc365 commit 4250cc2
Show file tree
Hide file tree
Showing 83 changed files with 193 additions and 193 deletions.
4 changes: 2 additions & 2 deletions libs/alignment/AlignmentSubsystemForDrivers.h
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ class AlignmentSubsystemForDrivers : public MapPropertiesToInMemoryDatabase,
/// \brief Virtual destructor
virtual ~AlignmentSubsystemForDrivers() {}

/** \brief Initilize alignment subsystem properties. It is recommended to call this function within initProperties() of your primary device
/** \brief Initialize alignment subsystem properties. It is recommended to call this function within initProperties() of your primary device
* \param[in] pTelescope Pointer to the child INDI::Telecope class
*/
void InitAlignmentProperties(Telescope *pTelescope);
Expand Down Expand Up @@ -173,7 +173,7 @@ class AlignmentSubsystemForDrivers : public MapPropertiesToInMemoryDatabase,
* the in memory database module. This registration is performed in the constructor of
* of this class. The callback is called whenever the database is
* is loaded or reloaded, by default it calls the Initialise function of the MathPluginManagment module.
* \param[in] ThisPointer Pointer to the instance of this class which registered the callbck
* \param[in] ThisPointer Pointer to the instance of this class which registered the callback
*/
static void MyDatabaseLoadCallback(void *ThisPointer);
};
Expand Down
4 changes: 2 additions & 2 deletions libs/alignment/BasicMathPlugin.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -464,7 +464,7 @@ bool BasicMathPlugin::TransformCelestialToTelescope(const double RightAscension,
#ifdef CONVEX_HULL_DEBUGGING
ActualFaces++;
#endif
// Ignore faces containg vertex 0 (nadir).
// Ignore faces containing vertex 0 (nadir).
if ((0 == CurrentFace->vertex[0]->vnum) || (0 == CurrentFace->vertex[1]->vnum) ||
(0 == CurrentFace->vertex[2]->vnum))
{
Expand Down Expand Up @@ -695,7 +695,7 @@ bool BasicMathPlugin::TransformTelescopeToCelestial(const TelescopeDirectionVect
#ifdef CONVEX_HULL_DEBUGGING
ApparentFaces++;
#endif
// Ignore faces containg vertex 0 (nadir).
// Ignore faces containing vertex 0 (nadir).
if ((0 == CurrentFace->vertex[0]->vnum) || (0 == CurrentFace->vertex[1]->vnum) ||
(0 == CurrentFace->vertex[2]->vnum))
{
Expand Down
4 changes: 2 additions & 2 deletions libs/alignment/BasicMathPlugin.h
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ class BasicMathPlugin : public AlignmentSubsystemForMathPlugins
double &RightAscension, double &Declination);

protected:
/// \brief Calculate tranformation matrices from the supplied vectors
/// \brief Calculate transformation matrices from the supplied vectors
/// \param[in] Alpha1 Pointer to the first coordinate in the alpha reference frame
/// \param[in] Alpha2 Pointer to the second coordinate in the alpha reference frame
/// \param[in] Alpha3 Pointer to the third coordinate in the alpha reference frame
Expand All @@ -67,7 +67,7 @@ class BasicMathPlugin : public AlignmentSubsystemForMathPlugins
/// \param[in] pMatrix The matrix to print
void Dump3x3(const char *Label, gsl_matrix *pMatrix);

/// \brief Caluclate the determinant of the supplied matrix
/// \brief Calculate the determinant of the supplied matrix
/// \param[in] pMatrix Pointer to the 3x3 matrix
/// \return The determinant
double Matrix3x3Determinant(gsl_matrix *pMatrix);
Expand Down
2 changes: 1 addition & 1 deletion libs/alignment/BuiltInMathPlugin.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ namespace AlignmentSubsystem
class BuiltInMathPlugin : public BasicMathPlugin
{
private:
/// \brief Calculate tranformation matrices from the supplied vectors
/// \brief Calculate transformation matrices from the supplied vectors
/// \param[in] Alpha1 Pointer to the first coordinate in the alpha reference frame
/// \param[in] Alpha2 Pointer to the second coordinate in the alpha reference frame
/// \param[in] Alpha3 Pointer to the third coordinate in the alpha reference frame
Expand Down
20 changes: 10 additions & 10 deletions libs/alignment/ClientAPIForAlignmentDatabase.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ ClientAPIForAlignmentDatabase::~ClientAPIForAlignmentDatabase()

bool ClientAPIForAlignmentDatabase::AppendSyncPoint(const AlignmentDatabaseEntry &CurrentValues)
{
// Wait for driver to initialise if neccessary
// Wait for driver to initialise if necessary
WaitForDriverCompletion();

auto pAction = Action->getSwitch();
Expand Down Expand Up @@ -69,7 +69,7 @@ bool ClientAPIForAlignmentDatabase::AppendSyncPoint(const AlignmentDatabaseEntry

bool ClientAPIForAlignmentDatabase::ClearSyncPoints()
{
// Wait for driver to initialise if neccessary
// Wait for driver to initialise if necessary
WaitForDriverCompletion();

auto pAction = Action->getSwitch();
Expand Down Expand Up @@ -107,7 +107,7 @@ bool ClientAPIForAlignmentDatabase::ClearSyncPoints()

bool ClientAPIForAlignmentDatabase::DeleteSyncPoint(unsigned int Offset)
{
// Wait for driver to initialise if neccessary
// Wait for driver to initialise if necessary
WaitForDriverCompletion();

auto pAction = Action->getSwitch();
Expand Down Expand Up @@ -158,7 +158,7 @@ bool ClientAPIForAlignmentDatabase::DeleteSyncPoint(unsigned int Offset)

bool ClientAPIForAlignmentDatabase::EditSyncPoint(unsigned int Offset, const AlignmentDatabaseEntry &CurrentValues)
{
// Wait for driver to initialise if neccessary
// Wait for driver to initialise if necessary
WaitForDriverCompletion();

auto pAction = Action->getSwitch();
Expand Down Expand Up @@ -222,7 +222,7 @@ void ClientAPIForAlignmentDatabase::Initialise(INDI::BaseClient *BaseClient)

bool ClientAPIForAlignmentDatabase::InsertSyncPoint(unsigned int Offset, const AlignmentDatabaseEntry &CurrentValues)
{
// Wait for driver to initialise if neccessary
// Wait for driver to initialise if necessary
WaitForDriverCompletion();

auto pAction = Action->getSwitch();
Expand Down Expand Up @@ -276,7 +276,7 @@ bool ClientAPIForAlignmentDatabase::InsertSyncPoint(unsigned int Offset, const A

bool ClientAPIForAlignmentDatabase::LoadDatabase()
{
// Wait for driver to initialise if neccessary
// Wait for driver to initialise if necessary
WaitForDriverCompletion();

auto pAction = Action->getSwitch();
Expand Down Expand Up @@ -379,7 +379,7 @@ void ClientAPIForAlignmentDatabase::ProcessNewProperty(INDI::Property *PropertyP
else
GotOneOfMine = false;

// Tell the client when all the database proeprties have been set up
// Tell the client when all the database properties have been set up
if (GotOneOfMine && (nullptr != MandatoryNumbers) && (nullptr != OptionalBinaryBlob) && (nullptr != PointsetSize) &&
(nullptr != CurrentEntry) && (nullptr != Action) && (nullptr != Commit))
{
Expand All @@ -406,7 +406,7 @@ void ClientAPIForAlignmentDatabase::ProcessNewSwitch(ISwitchVectorProperty *Swit

bool ClientAPIForAlignmentDatabase::ReadIncrementSyncPoint(AlignmentDatabaseEntry &CurrentValues)
{
// Wait for driver to initialise if neccessary
// Wait for driver to initialise if necessary
WaitForDriverCompletion();

auto pAction = Action->getSwitch();
Expand Down Expand Up @@ -458,7 +458,7 @@ bool ClientAPIForAlignmentDatabase::ReadIncrementSyncPoint(AlignmentDatabaseEntr

bool ClientAPIForAlignmentDatabase::ReadSyncPoint(unsigned int Offset, AlignmentDatabaseEntry &CurrentValues)
{
// Wait for driver to initialise if neccessary
// Wait for driver to initialise if necessary
WaitForDriverCompletion();

auto pAction = Action->getSwitch();
Expand Down Expand Up @@ -520,7 +520,7 @@ bool ClientAPIForAlignmentDatabase::ReadSyncPoint(unsigned int Offset, Alignment

bool ClientAPIForAlignmentDatabase::SaveDatabase()
{
// Wait for driver to initialise if neccessary
// Wait for driver to initialise if necessary
WaitForDriverCompletion();

auto pAction = Action->getSwitch();
Expand Down
8 changes: 4 additions & 4 deletions libs/alignment/ClientAPIForMathPluginManagement.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ namespace AlignmentSubsystem

bool ClientAPIForMathPluginManagement::EnumerateMathPlugins(MathPluginsList &AvailableMathPlugins)
{
// Wait for driver to initialise if neccessary
// Wait for driver to initialise if necessary
WaitForDriverCompletion();

AvailableMathPlugins.clear();
Expand Down Expand Up @@ -52,7 +52,7 @@ void ClientAPIForMathPluginManagement::ProcessNewProperty(INDI::Property *Proper
else
GotOneOfMine = false;

// Tell the client when all the database proeprties have been set up
// Tell the client when all the database properties have been set up
if (GotOneOfMine && (nullptr != MathPlugins) && (nullptr != PluginInitialise))
{
// The DriverActionComplete state variable is initialised to false
Expand All @@ -78,7 +78,7 @@ void ClientAPIForMathPluginManagement::ProcessNewSwitch(ISwitchVectorProperty *S

bool ClientAPIForMathPluginManagement::SelectMathPlugin(const std::string &MathPluginName)
{
// Wait for driver to initialise if neccessary
// Wait for driver to initialise if necessary
WaitForDriverCompletion();

auto pPlugins = MathPlugins->getSwitch();
Expand Down Expand Up @@ -107,7 +107,7 @@ bool ClientAPIForMathPluginManagement::SelectMathPlugin(const std::string &MathP

bool ClientAPIForMathPluginManagement::ReInitialiseMathPlugin()
{
// Wait for driver to initialise if neccessary
// Wait for driver to initialise if necessary
WaitForDriverCompletion();

auto pPluginInitialise = PluginInitialise->getSwitch();
Expand Down
2 changes: 1 addition & 1 deletion libs/alignment/ClientAPIForMathPluginManagement.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class ClientAPIForMathPluginManagement
*/
bool EnumerateMathPlugins(MathPluginsList &AvailableMathPlugins);

/// \brief Intialise the API
/// \brief Initialise the API
/// \param[in] BaseClient Pointer to the INDI:BaseClient class
void Initialise(INDI::BaseClient *BaseClient);

Expand Down
4 changes: 2 additions & 2 deletions libs/alignment/Common.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ namespace AlignmentSubsystem
{
/** \enum MountAlignment
\brief Describe the alignment of a telescope axis. This is normally used to differentiate between
equatorial mounts in differnet hemispheres and altaz or dobsonian mounts.
equatorial mounts in different hemispheres and altaz or dobsonian mounts.
*/
typedef enum MountAlignment { ZENITH, NORTH_CELESTIAL_POLE, SOUTH_CELESTIAL_POLE } MountAlignment_t;

Expand Down Expand Up @@ -59,7 +59,7 @@ enum AlignmentPointSetEnum

/*!
* \struct TelescopeDirectionVector
* \brief Holds a nomalised direction vector (direction cosines)
* \brief Holds a normalised direction vector (direction cosines)
*
* The x y,z fields of this class should normally represent a normalised (unit length)
* vector in a right handed rectangular coordinate space. However, for convenience a number
Expand Down
2 changes: 1 addition & 1 deletion libs/alignment/InMemoryDatabase.h
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ class InMemoryDatabase
}

/// \brief Get the database reference position
/// \param[in] Position A pointer to a IGeographicCoordinates object to retunr the current position in
/// \param[in] Position A pointer to a IGeographicCoordinates object to return the current position in
/// \return True if successful
bool GetDatabaseReferencePosition(IGeographicCoordinates &Position);

Expand Down
2 changes: 1 addition & 1 deletion libs/alignment/MapPropertiesToInMemoryDatabase.h
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ namespace AlignmentSubsystem
* - READ INCREMENT\n
* Increment the pointer before reading the entry.
* - LOAD DATABASE\n
* Load the databse from local storage.
* Load the database from local storage.
* - SAVE DATABASE\n
* Save the database to local storage.
* - ALIGNMENT_POINTSET_COMMIT\n
Expand Down
4 changes: 2 additions & 2 deletions libs/alignment/MathPlugin.h
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ class MathPlugin
virtual ~MathPlugin() {}

// Public methods
/// \brief Get the approximate alognment of the mount
/// \brief Get the approximate alignment of the mount
/// \return the approximate alignment
virtual MountAlignment_t GetApproximateMountAlignment()
{
Expand All @@ -50,7 +50,7 @@ class MathPlugin
/// \return True if successful
virtual bool Initialise(InMemoryDatabase *pInMemoryDatabase);

/// \brief Set the approximate alognment of the mount
/// \brief Set the approximate alignment of the mount
/// \param[in] ApproximateAlignment - the approximate alignment of the mount
virtual void SetApproximateMountAlignment(MountAlignment_t ApproximateAlignment)
{
Expand Down
2 changes: 1 addition & 1 deletion libs/alignment/NearestMathPlugin.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ bool NearestMathPlugin::Initialise(InMemoryDatabase *pInMemoryDatabase)

// JM: We iterate over all the sync point and compute the celestial and telescope horizontal coordinates
// Since these are used to sort the nearest alignment points to the current target. The offsets of the
// nearest point celestial coordintes are then applied to the current target to correct for its position.
// nearest point celestial coordinates are then applied to the current target to correct for its position.
// No complex transformations used.
for (auto &oneSyncPoint : SyncPoints)
{
Expand Down
2 changes: 1 addition & 1 deletion libs/alignment/SVDMathPlugin.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ void SVDMathPlugin::CalculateTransformMatrices(const TelescopeDirectionVector &A
gsl_matrix *pIntermediateMatrix1 = gsl_matrix_alloc(3, 3);
MatrixMatrixMultiply(pBetaMatrix, pAlphaMatrix, pIntermediateMatrix1);

// 3. Compute the singular value decomoposition of the intermediate matrix
// 3. Compute the singular value decomposition of the intermediate matrix
gsl_matrix *pV = gsl_matrix_alloc(3, 3);
gsl_vector *pS = gsl_vector_alloc(3);
gsl_vector *pWork = gsl_vector_alloc(3);
Expand Down
2 changes: 1 addition & 1 deletion libs/alignment/SVDMathPlugin.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ namespace AlignmentSubsystem
class SVDMathPlugin : public BasicMathPlugin
{
private:
/// \brief Calculate tranformation matrices from the supplied vectors
/// \brief Calculate transformation matrices from the supplied vectors
/// \param[in] Alpha1 Pointer to the first coordinate in the alpha reference frame
/// \param[in] Alpha2 Pointer to the second coordinate in the alpha reference frame
/// \param[in] Alpha3 Pointer to the third coordinate in the alpha reference frame
Expand Down
2 changes: 1 addition & 1 deletion libs/alignment/TelescopeDirectionVectorSupportFunctions.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ namespace AlignmentSubsystem
/*! \class TelescopeDirectionVectorSupportFunctions
* \brief These functions are used to convert different coordinate systems to and from the
* telescope direction vectors (normalised vector/direction cosines) used for telescope coordinates in the
* alignment susbsystem.
* alignment subsystem.
*/
class TelescopeDirectionVectorSupportFunctions
{
Expand Down
8 changes: 4 additions & 4 deletions libs/alignment/alignment_white_paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -418,7 +418,7 @@ The final step is to add coordinate conversion to ReadScopeStatus, TimerHit (for
{
if (AzimuthOffsetMicrosteps < MICROSTEPS_PER_REVOLUTION / 2.0)
{
// Foward
// Forward
AxisDirectionRA = FORWARD;
AxisSlewRateRA = AzimuthOffsetMicrosteps;
}
Expand All @@ -434,7 +434,7 @@ The final step is to add coordinate conversion to ReadScopeStatus, TimerHit (for
AzimuthOffsetMicrosteps = abs(AzimuthOffsetMicrosteps);
if (AzimuthOffsetMicrosteps < MICROSTEPS_PER_REVOLUTION / 2.0)
{
// Foward
// Forward
AxisDirectionRA = REVERSE;
AxisSlewRateRA = AzimuthOffsetMicrosteps;
}
Expand Down Expand Up @@ -615,7 +615,7 @@ The Alignment Subsystem provides two API classes for use in clients. These are C

class LoaderClient : public INDI::BaseClient, INDI::AlignmentSubsystem::AlignmentSubsystemForClients

Somewhere in the initialisation of your client make a call to the Initalise method of the AlignmentSubsystemForClients class for example:
Somewhere in the initialisation of your client make a call to the Initialise method of the AlignmentSubsystemForClients class for example:

void LoaderClient::Initialise(int argc, char* argv[])
{
Expand Down Expand Up @@ -643,7 +643,7 @@ Somewhere in the initialisation of your client make a call to the Initalise meth
setBLOBMode(B_ALSO, DeviceName.c_str(), NULL);
}

To hook the Alignment Subsystem into the clients property handling you must ensure that the following virtual functions are overriden.
To hook the Alignment Subsystem into the clients property handling you must ensure that the following virtual functions are overridden.

virtual void newBLOB(IBLOB *bp);
virtual void newDevice(INDI::BaseDevice *dp);
Expand Down
14 changes: 7 additions & 7 deletions libs/dsp/dsp.h
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ extern "C" {
* The DSP API is a collection of essential routines used in astronomy signal processing<br>
*
* The DSP API is used for processing monodimensional or multidimensional buffers,<br>
* generating, tranforming, stack, processing buffers, aligning, convoluting arrays,<br>
* converting array element types, generate statistics, extract informations from buffers, convolute or<br>
* generating, transforming, stack, processing buffers, aligning, convoluting arrays,<br>
* converting array element types, generate statistics, extract information from buffers, convolute or<br>
* cross-correlate different single or multi dimensional streams, rotate, scale, crop images.<br>
*
* \author Ilia Platone
Expand Down Expand Up @@ -280,7 +280,7 @@ typedef struct dsp_triangle_t
} dsp_triangle;

/**
* \brief Alignment informations needed
* \brief Alignment information needed
*/
typedef struct dsp_align_info_t
{
Expand Down Expand Up @@ -366,7 +366,7 @@ typedef union dsp_location_t
typedef void *(*dsp_func_t) (void *, ...);

/**
* \brief Contains a set of informations and data relative to a buffer and how to use it
* \brief Contains a set of information and data relative to a buffer and how to use it
* \sa dsp_stream_new
* \sa dsp_stream_add_dim
* \sa dsp_stream_del_dim
Expand Down Expand Up @@ -469,7 +469,7 @@ DLL_EXPORT void dsp_fourier_idft(dsp_stream_p stream);
DLL_EXPORT void dsp_fourier_2dsp(dsp_stream_p stream);

/**
* \brief Obtain the complex fourier tranform from the current magnitude and phase buffers
* \brief Obtain the complex fourier transform from the current magnitude and phase buffers
* \param stream the inout stream.
*/
DLL_EXPORT void dsp_fourier_2complex_t(dsp_stream_p stream);
Expand Down Expand Up @@ -774,7 +774,7 @@ DLL_EXPORT void dsp_convolution_correlation(dsp_stream_p stream, dsp_stream_p ma
* \brief Histogram of the inut stream
* \param stream the stream on which execute
* \param size the length of the median.
* \return the output stream if successfull elaboration. NULL if an
* \return the output stream if successful elaboration. NULL if an
* error is encountered.
*/
DLL_EXPORT double* dsp_stats_histogram(dsp_stream_p stream, int size);
Expand Down Expand Up @@ -1532,7 +1532,7 @@ DLL_EXPORT dsp_t* dsp_file_composite_2_bayer(dsp_stream_p *src, int red, int wid
DLL_EXPORT void dsp_file_write_fits_bayer(const char* filename, int components, int bpp, dsp_stream_p* stream);

/**
* \brief Convert a bayer pattern dsp_t array into a contiguos component array
* \brief Convert a bayer pattern dsp_t array into a contiguous component array
* \param src the input buffer
* \param red the location of the red pixel within the bayer pattern
* \param width the picture width
Expand Down
Loading

0 comments on commit 4250cc2

Please sign in to comment.