From 5d22d90cc0a67be2e383151ea301b52cff973c3b Mon Sep 17 00:00:00 2001
From: Carles Fernandez <carles.fernandez@gmail.com>
Date: Thu, 16 Jul 2015 18:54:57 +0200
Subject: [PATCH] Fixing documentation
---
.../two_bit_cpx_file_signal_source.cc | 9 ++-
.../adapters/two_bit_cpx_file_signal_source.h | 9 ++-
.../unpack_byte_2bit_cpx_samples.cc | 63 ++++++++++---------
3 files changed, 41 insertions(+), 40 deletions(-)
diff --git a/src/algorithms/signal_source/adapters/two_bit_cpx_file_signal_source.cc b/src/algorithms/signal_source/adapters/two_bit_cpx_file_signal_source.cc
index af41031f0..d9679368f 100644
--- a/src/algorithms/signal_source/adapters/two_bit_cpx_file_signal_source.cc
+++ b/src/algorithms/signal_source/adapters/two_bit_cpx_file_signal_source.cc
@@ -1,9 +1,8 @@
/*!
- * \file nsr_file_signal_source.cc
- * \brief Implementation of a class that reads signals samples from a NSR 2 bits sampler front-end file
- * and adapts it to a SignalSourceInterface. More information about the front-end here
- * http://www.ifen.com/products/sx-scientific-gnss-solutions/nsr-software-receiver.html
- * \author Javier Arribas, 2013 jarribas(at)cttc.es
+ * \file two_bit_cpx_file_signal_source.cc
+ * \brief Implementation of a class that reads signals samples from a 2 bit complex sampler front-end file
+ * and adapts it to a SignalSourceInterface.
+ * \author Javier Arribas, 2015 jarribas(at)cttc.es
*
* -------------------------------------------------------------------------
*
diff --git a/src/algorithms/signal_source/adapters/two_bit_cpx_file_signal_source.h b/src/algorithms/signal_source/adapters/two_bit_cpx_file_signal_source.h
index 65c74f4ba..a7f8d1adc 100644
--- a/src/algorithms/signal_source/adapters/two_bit_cpx_file_signal_source.h
+++ b/src/algorithms/signal_source/adapters/two_bit_cpx_file_signal_source.h
@@ -1,9 +1,8 @@
/*!
- * \file nsr_file_signal_source.h
- * \brief Implementation of a class that reads signals samples from a NSR 2 bits sampler front-end file
- * and adapts it to a SignalSourceInterface. More information about the front-end here
- * http://www.ifen.com/products/sx-scientific-gnss-solutions/nsr-software-receiver.html
- * \author Javier Arribas, 2013 jarribas(at)cttc.es
+ * \file two_bit_cpx_file_signal_source.h
+ * \brief Interface of a class that reads signals samples from a 2 bit complex sampler front-end file
+ * and adapts it to a SignalSourceInterface.
+ * \author Javier Arribas, 2015 jarribas(at)cttc.es
*
* This class represents a file signal source.
*
diff --git a/src/algorithms/signal_source/gnuradio_blocks/unpack_byte_2bit_cpx_samples.cc b/src/algorithms/signal_source/gnuradio_blocks/unpack_byte_2bit_cpx_samples.cc
index 617a25bfe..a33068651 100644
--- a/src/algorithms/signal_source/gnuradio_blocks/unpack_byte_2bit_cpx_samples.cc
+++ b/src/algorithms/signal_source/gnuradio_blocks/unpack_byte_2bit_cpx_samples.cc
@@ -1,7 +1,11 @@
/*!
* \file unpack_byte_2bit_cpx_samples.cc
*
- * \brief Unpacks byte samples to NSR 2 bits samples
+ * \brief Unpacks byte samples to 2 bits complex samples.
+ * Packing Order
+ * Most Significant Nibble - Sample n
+ * Least Significant Nibble - Sample n+1
+ * Packing order in Nibble Q1 Q0 I1 I0
* \author Javier Arribas jarribas (at) cttc.es
* -------------------------------------------------------------------------
*
@@ -54,8 +58,8 @@ unpack_byte_2bit_cpx_samples::~unpack_byte_2bit_cpx_samples()
{}
int unpack_byte_2bit_cpx_samples::work(int noutput_items,
- gr_vector_const_void_star &input_items,
- gr_vector_void_star &output_items)
+ gr_vector_const_void_star &input_items,
+ gr_vector_void_star &output_items)
{
const signed char *in = (const signed char *)input_items[0];
short *out = (short*)output_items[0];
@@ -65,40 +69,39 @@ int unpack_byte_2bit_cpx_samples::work(int noutput_items,
for(int i = 0; i < noutput_items/4; i++)
{
// Read packed input sample (1 byte = 2 complex samples)
- //* Packing Order
- //* Most Significant Nibble - Sample n
- //* Least Significant Nibble - Sample n+1
- //* Packing order in Nibble Q1 Q0 I1 I0
- //normal
-// signed char c = in[i];
-// //Q[n]
-// sample.two_bit_sample = (c>>6) & 3;
-// out[n++] = (2*(short)sample.two_bit_sample+1);
-// //I[n]
-// sample.two_bit_sample = (c>>4) & 3;
-// out[n++] = (2*(short)sample.two_bit_sample+1);
-// //Q[n+1]
-// sample.two_bit_sample = (c>>2) & 3;
-// out[n++] = (2*(short)sample.two_bit_sample+1);
-// //I[n+1]
-// sample.two_bit_sample = c & 3;
-// out[n++] = (2*(short)sample.two_bit_sample+1);
+ //* Packing Order
+ //* Most Significant Nibble - Sample n
+ //* Least Significant Nibble - Sample n+1
+ //* Packing order in Nibble Q1 Q0 I1 I0
+ //normal
+ // signed char c = in[i];
+ // //Q[n]
+ // sample.two_bit_sample = (c>>6) & 3;
+ // out[n++] = (2*(short)sample.two_bit_sample+1);
+ // //I[n]
+ // sample.two_bit_sample = (c>>4) & 3;
+ // out[n++] = (2*(short)sample.two_bit_sample+1);
+ // //Q[n+1]
+ // sample.two_bit_sample = (c>>2) & 3;
+ // out[n++] = (2*(short)sample.two_bit_sample+1);
+ // //I[n+1]
+ // sample.two_bit_sample = c & 3;
+ // out[n++] = (2*(short)sample.two_bit_sample+1);
- //I/Q swap
+ //I/Q swap
signed char c = in[i];
//I[n]
- sample.two_bit_sample = (c>>4) & 3;
- out[n++] = (2*(short)sample.two_bit_sample+1);
+ sample.two_bit_sample = (c >> 4) & 3;
+ out[n++] = (2*(short)sample.two_bit_sample + 1);
//Q[n]
- sample.two_bit_sample = (c>>6) & 3;
- out[n++] = (2*(short)sample.two_bit_sample+1);
+ sample.two_bit_sample = (c >> 6) & 3;
+ out[n++] = (2*(short)sample.two_bit_sample + 1);
//I[n+1]
sample.two_bit_sample = c & 3;
- out[n++] = (2*(short)sample.two_bit_sample+1);
+ out[n++] = (2*(short)sample.two_bit_sample + 1);
//Q[n+1]
- sample.two_bit_sample = (c>>2) & 3;
- out[n++] = (2*(short)sample.two_bit_sample+1);
-
+ sample.two_bit_sample = (c >> 2) & 3;
+ out[n++] = (2*(short)sample.two_bit_sample + 1);
}
return noutput_items;
}