Merge pull request #131 from open-ephys-plugins/issue-129

Update Probe Interface compatibility

Author: bparks13

Source/Formats/ProbeInterface.h

@@ -120,48 +120,77 @@ namespace OnixSourcePlugin
 			auto json = JSON::parse(file);
 
 			if (json == var())
+			{
+				Onix1::showWarningMessageBoxAsync("Unable to Parse File", "The file '" + file.getFileName().toStdString() + "' could not be parsed. " +
+					"Please ensure that the file exists and is in the correct format.");
 				return false;
+			}
 
 			DynamicObject::Ptr obj = json.getDynamicObject();
 
 			if (obj->hasProperty(Identifier("specification")))
 			{
 				std::string specification = obj->getProperty(Identifier("specification")).toString().toStdString();
 
-				if (specification.compare("probeinterface") != 0)
+				const std::string probeInterfaceSpecification = "probeinterface";
+
+				if (specification.compare(probeInterfaceSpecification) != 0)
+				{
+					Onix1::showWarningMessageBoxAsync("Invalid Specification", "The specification listed in the Probe Interface file is '" + specification +
+						"', but it is expected to be '" + probeInterfaceSpecification + "'.");
 					return false;
+				}
 			}
 			else
+			{
+				Onix1::showWarningMessageBoxAsync("No Specification Found", "No specification field was found in the JSON file.");
 				return false;
+			}
 
 			if (obj->hasProperty(Identifier("probes")))
 			{
 				Array<var>* probes = obj->getProperty(Identifier("probes")).getArray();
 
 				if (probes->size() != 1)
+				{
+					Onix1::showWarningMessageBoxAsync("Wrong Number of Probes", "Expected to find one probe listed in this file, but found " +
+						std::to_string(probes->size()) + " probes in the file.");
 					return false;
+				}
 
 				DynamicObject::Ptr probe = probes->getReference(0).getDynamicObject();
 
 				if (probe->hasProperty(Identifier("ndim")))
 				{
 					if (!probe->getProperty(Identifier("ndim")).equalsWithSameType(2))
 					{
+						Onix1::showWarningMessageBoxAsync("Invalid Number of Dimensions", "Expected this file to contain two dimensions, but found `"
+							+ probe->getProperty(Identifier("ndim")).toString().toStdString() + "` instead.");
 						return false;
 					}
 				}
 				else
+				{
+					Onix1::showWarningMessageBoxAsync("No Dimensions Found", "Could not find the number of dimensions in the file.");
 					return false;
+				}
 
 				if (probe->hasProperty(Identifier("si_units")))
 				{
-					if (!probe->getProperty(Identifier("si_units")).equalsWithSameType("um"))
+					const std::string um = "um";
+
+					if (!probe->getProperty(Identifier("si_units")).equalsWithSameType(var(um)))
 					{
+						Onix1::showWarningMessageBoxAsync("Unexpected Units Found", "Expected to see units `" + um + "`, but found `"
+							+ probe->getProperty(Identifier("si_units")).toString().toStdString() + "` instead.");
 						return false;
 					}
 				}
 				else
+				{
+					Onix1::showWarningMessageBoxAsync("No Units Found", "Could not find any units in the file.");
 					return false;
+				}
 
 				Array<var>* contact_positions = nullptr;
 
@@ -170,10 +199,17 @@ namespace OnixSourcePlugin
 					contact_positions = probe->getProperty(Identifier("contact_positions")).getArray();
 
 					if (contact_positions->size() != settings->electrodeMetadata.size())
+					{
+						Onix1::showWarningMessageBoxAsync("Different Number of Contacts", "Expected to find " + std::to_string(settings->electrodeMetadata.size()) +
+							" contacts, but found " + std::to_string(contact_positions->size()) + " contacts instead.");
 						return false;
+					}
 				}
 				else
+				{
+					Onix1::showWarningMessageBoxAsync("No Contacts Found", "Could not find any contacts in the file.");
 					return false;
+				}
 
 				Array<var>* probe_planar_contour = nullptr;
 
@@ -182,7 +218,9 @@ namespace OnixSourcePlugin
 					probe_planar_contour = probe->getProperty(Identifier("probe_planar_contour")).getArray();
 				}
 				else
-					return false;
+				{
+					LOGD("No probe planar contour found.");
+				}
 
 				Array<var>* device_channel_indices = nullptr;
 
@@ -191,10 +229,17 @@ namespace OnixSourcePlugin
 					device_channel_indices = probe->getProperty(Identifier("device_channel_indices")).getArray();
 
 					if (device_channel_indices->size() != settings->electrodeMetadata.size())
+					{
+						Onix1::showWarningMessageBoxAsync("Wrong Number of Indices Found", "Expected to find " + std::to_string(settings->electrodeMetadata.size()) +
+							" device channel indices, but found " + std::to_string(device_channel_indices->size()) + " instead.");
 						return false;
+					}
 				}
 				else
+				{
+					Onix1::showWarningMessageBoxAsync("No Indices Found", "No device channel indices found in the file.");
 					return false;
+				}
 
 				Array<var>* shank_ids = nullptr;
 
@@ -203,10 +248,17 @@ namespace OnixSourcePlugin
 					shank_ids = probe->getProperty(Identifier("shank_ids")).getArray();
 
 					if (shank_ids->size() != settings->electrodeMetadata.size())
+					{
+						Onix1::showWarningMessageBoxAsync("Wrong Number of Shank IDs Found", "Expected to find " + std::to_string(settings->electrodeMetadata.size()) +
+							" shank IDs, but found " + std::to_string(shank_ids->size()) + " instead.");
 						return false;
+					}
 				}
 				else
+				{
+					Onix1::showWarningMessageBoxAsync("No Shank IDs Found", "No shank IDs found in the file.");
 					return false;
+				}
 
 				for (int ch = 0; ch < contact_positions->size(); ch++)
 				{
@@ -218,11 +270,14 @@ namespace OnixSourcePlugin
 
 				settings->probeMetadata.probeContour.clear();
 
-				for (int i = 0; i < probe_planar_contour->size(); i++)
+				if (probe_planar_contour != nullptr)
 				{
-					Array<var>* point = probe_planar_contour->getReference(i).getArray();
+					for (int i = 0; i < probe_planar_contour->size(); i++)
+					{
+						Array<var>* point = probe_planar_contour->getReference(i).getArray();
 
-					settings->probeMetadata.probeContour.emplace_back(std::array<float, 2>{float(point->getReference(0)), float(point->getReference(1))});
+						settings->probeMetadata.probeContour.emplace_back(std::array<float, 2>{float(point->getReference(0)), float(point->getReference(1))});
+					}
 				}
 
 				for (int ch = 0; ch < shank_ids->size(); ch++)
@@ -244,7 +299,10 @@ namespace OnixSourcePlugin
 				settings->selectElectrodes(selectedChannels);
 			}
 			else
+			{
+				Onix1::showWarningMessageBoxAsync("No Probes Found", "Could not find any probes in the file.");
 				return false;
+			}
 
 			return true;
 		}